Script API - v1.21.0
    Preparing search index...

    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;
    }
    Index

    Properties

    id onModalToolActivation

    Methods

    bindPropertyPane dispose hide registerKeyBinding registerMouseButtonBinding registerMouseDragBinding registerMouseWheelBinding show unregisterInputBindings

    Properties

    id: string

    Unique ID for the tool

    onModalToolActivation: EventSink<ModalToolLifecycleEventPayload>

    Provides lifecycle activation events for a modal tool

    Methods

    • Beta

      Returns void

    • Beta

      Returns void

    • Beta

      Returns void

    • Beta

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods