Documentation - v19.2.0-dev
    Preparing search index...

    Class ShowMapShortcut

    The shortcut to show or hide the map

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    action enabled isToggable

    Accessors

    label

    Methods

    execute getKeyboardShortcutString matchEvent resetDefaultBinding setBinding

    Constructors

    Properties

    action: "plugin.map.show" = 'plugin.map.show'
    enabled: boolean = true

    Indicates whehter the shortcut is enabled

    isToggable: boolean = false

    Accessors

    • get label(): string

      Get translation

      Returns string

    Methods

    • Executes the keyboard shortcuts

      Parameters

      • viewer: Viewer

        The viewer to interact with

      Returns Promise<void>

    • Get the shortcut in string format to display it

      Returns string

    • Returns whether the shortcut matches the given input keyboard event state

      Parameters

      • event: KeyboardEvent

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods