Interface IModalTool

interface IModalTool {
    id: string;
    onModalToolActivation: EventSink<ModalToolLifecycleEventPayload>;
    bindPropertyPane(pane: IRootPropertyPane): void;
    registerKeyBinding(
        action: SupportedKeyboardActionTypes,
        binding: KeyBinding,
        info?: KeyBindingInfo,
    ): IRegisteredKeyBinding;
    registerMouseButtonBinding(action: SupportedMouseActionTypes): void;
    registerMouseDragBinding(action: SupportedMouseActionTypes): void;
    registerMouseWheelBinding(action: SupportedMouseActionTypes): void;
    unregisterInputBindings(): void;
}

Index

Properties

id onModalToolActivation

Methods

bindPropertyPane registerKeyBinding registerMouseButtonBinding registerMouseDragBinding registerMouseWheelBinding unregisterInputBindings

Properties

`Readonly`id

id: string

Remarks

Unique identifier for the tool

onModalToolActivation

onModalToolActivation: EventSink<ModalToolLifecycleEventPayload>

Remarks

Provides lifecycle activation events for a modal tool

Methods

bindPropertyPane

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

registerKeyBinding

registerKeyBinding(
    action: SupportedKeyboardActionTypes,
    binding: KeyBinding,
    info?: KeyBindingInfo,
): IRegisteredKeyBinding
Parameters
- action: SupportedKeyboardActionTypes
- binding: KeyBinding
- Optionalinfo: KeyBindingInfo
Returns IRegisteredKeyBinding

registerMouseButtonBinding

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

registerMouseDragBinding

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

registerMouseWheelBinding

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

unregisterInputBindings

unregisterInputBindings(): void
Returns void