接口 ISimpleToolOptions实验性

A set of options which define the basic properties of a simple tool, and the optional components that are desired.

interface ISimpleToolOptions {
    activationKeyBinding?: ISimpleToolKeyBinding;
    id: string;
    name: string;
    onFinalize?: ((tool: ISimpleTool) => void);
    onTeardown?: ((tool: ISimpleTool) => void);
    propertyPaneOptions?: ISimpleToolPaneOptions;
    statusBarOptions?: ISimpleToolStatusBarOptions;
    toolRailOptions?: ISimpleToolRailOptions;
}

属性

activationKeyBinding? id name onFinalize? onTeardown? propertyPaneOptions? statusBarOptions? toolRailOptions?

属性

可选 实验性activationKeyBinding

activationKeyBinding?: ISimpleToolKeyBinding

备注

A key binding that will activate the tool. Note that if the tool is a modal tool, then the key binding will be tied to the tool rail activation, and appear as a tooltip on the tool rail button. If the tool is a global tool, then the key binding will be tied to a menu item in the View menu, and appear as a stateful menu item which will control the pane visibility. If there's no pane required, then the key binding is ignored

实验性id

id: string

备注

The unique identifier of the tool.

实验性name

name: string

备注

The name of the tool. This will be used to identify the tool in the UI and logs and will be used in the View > [Tool Name] menu item (if it's a global tool)

可选onFinalize

onFinalize?: ((tool: ISimpleTool) => void)

备注

The finalize function is executed after each of the components have been created and finalized during construction

可选onTeardown

onTeardown?: ((tool: ISimpleTool) => void)

备注

The teardown function is executed when the tool is being torn down and only after the individual components have executed their own teardown functions

可选 实验性propertyPaneOptions

propertyPaneOptions?: ISimpleToolPaneOptions

备注

The options structure for an optional property pane component

可选 实验性statusBarOptions

statusBarOptions?: ISimpleToolStatusBarOptions

备注

The options structure for an optional status bar component

可选 实验性toolRailOptions

toolRailOptions?: ISimpleToolRailOptions

备注

The options structure for an optional tool rail component

显示设置

成员可见性

目录

属性