Interface IModalTool

Hierarchy

IModalTool

Index

Properties

id onModalToolActivation

Methods

bindPropertyPane dispose hide registerKeyBinding registerMouseButtonBinding registerMouseDragBinding registerMouseWheelBinding show unregisterInputBindings

Properties

`Readonly` id

id: string

Remarks

Unique ID for the tool

onModalToolActivation

onModalToolActivation: EventSink<ModalToolLifecycleEventPayload>

Remarks

Provides lifecycle activation events for a modal tool

Methods

bindPropertyPane

bindPropertyPane(pane): void
Parameters
- pane: IPropertyPane
Returns void

dispose

dispose(): void
Returns void

hide

hide(): void
Returns void

registerKeyBinding

registerKeyBinding(action, button, modifier?): void
Parameters
- action: SupportedKeyboardActionTypes
- button: KeyboardKey
- Optional modifier: InputModifier
  Optional
Returns void

registerMouseButtonBinding

registerMouseButtonBinding(action): void
Parameters
- action: SupportedMouseActionTypes
Returns void

registerMouseDragBinding

registerMouseDragBinding(action): void
Parameters
- action: SupportedMouseActionTypes
Returns void

registerMouseWheelBinding

registerMouseWheelBinding(action): void
Parameters
- action: SupportedMouseActionTypes
Returns void

show

show(): void
Returns void

unregisterInputBindings

unregisterInputBindings(): void
Returns void