@stereograph/teiaviewer - v17.8.0-dev
    Preparing search index...

    Class ShowSpotlightShortcut

    Base class for Keyboard Shortcuts

    Hierarchy (View Summary)

    Index

    Constructors

    • Constructs a new Keyboard Shortcut

      Parameters

      • keys: Set<string>

        Main keys supported by the shortcut

      • modifiers: Partial<KeyboardShortcutModifiers> = {}

        Shortcut key modifiers

      • _shortcutEquivalences: Partial<Record<"unknown" | "azerty" | "qwerty", Set<string>>> = {}

      Returns ShowSpotlightShortcut

    Properties

    isToggable: boolean = false
    keys: Set<string> = ...
    modifiers: KeyboardShortcutModifiers = ...
    name: "ShowSpotlightShortcut" = 'ShowSpotlightShortcut'

    Accessors

    • get translation(): 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

      Parameters

      • keyboardType: "unknown" | "azerty" | "qwerty"

      Returns string

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

      Parameters

      • event: KeyboardEvent
      • holdingKeys: Set<string>
      • holdingCodes: Set<string>

      Returns boolean