Interface IModalToolBeta

interface IModalTool {
    id: string;
    onModalToolActivation: EventSink<ModalToolLifecycleEventPayload>;
    bindPropertyPane(pane: IPropertyPane): void;
    dispose(): void;
    hide(): void;
    registerKeyBinding(
        action: SupportedKeyboardActionTypes,
        button: KeyboardKey,
        modifier?: InputModifier,
    ): void;
    registerMouseButtonBinding(action: SupportedMouseActionTypes): void;
    registerMouseDragBinding(action: SupportedMouseActionTypes): void;
    registerMouseWheelBinding(action: SupportedMouseActionTypes): void;
    show(): void;
    unregisterInputBindings(): void;
}

Properties

id onModalToolActivation

Methods

bindPropertyPane dispose hide registerKeyBinding registerMouseButtonBinding registerMouseDragBinding registerMouseWheelBinding show unregisterInputBindings

Properties

Readonly Betaid

id: string

Remarks

Unique ID for the tool

BetaonModalToolActivation

onModalToolActivation: EventSink<ModalToolLifecycleEventPayload>

Remarks

Provides lifecycle activation events for a modal tool

Methods

bindPropertyPane

dispose

  • dispose(): void
    Beta

    Returns void

hide

  • hide(): void
    Beta

    Returns void

registerKeyBinding

registerMouseButtonBinding

registerMouseDragBinding

registerMouseWheelBinding

show

  • show(): void
    Beta

    Returns void

unregisterInputBindings

  • unregisterInputBindings(): void
    Beta

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods