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

Hierarchy

  • ISimpleToolOptions

Properties

activationKeyBinding?: ISimpleToolKeyBinding

Remarks

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

name: string

Remarks

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?: ((tool) => void)

Type declaration

    • (tool): void
    • Parameters

      Returns void

      Remarks

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

onTeardown?: ((tool) => void)

Type declaration

    • (tool): void
    • Parameters

      Returns void

      Remarks

      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?: ISimpleToolPaneOptions

Remarks

The options structure for an optional property pane component

statusBarOptions?: ISimpleToolStatusBarOptions

Remarks

The options structure for an optional status bar component

toolRailOptions?: ISimpleToolRailOptions

Remarks

The options structure for an optional tool rail component