Class DiagramKeyboard<T>

Type Parameters

T

Hierarchy (View Summary)

DiagramKeyboard
- DiagramViewKeyboard

Index

Constructors

Properties

Methods

register unregister setShortcut clear getShortcuts getShortcut getShortcutBySyntax getEventShortcut invokeEvent

Constructors

constructor

new DiagramKeyboard<T>(): DiagramKeyboard<T>
Type Parameters
- T
Returns DiagramKeyboard<T>

Properties

`Protected` `Readonly`shortcuts

shortcuts: KeyboardShortcut<T>[] = []

Methods

`Protected`register

register(shortcut: KeyboardShortcut<T>): void
Parameters
- shortcut: KeyboardShortcut<T>
Returns void
- Defined in src/keyboard/diagram.keyboard.ts:8

`Protected`unregister

unregister(shortcut: KeyboardShortcut<T>): void
Parameters
- shortcut: KeyboardShortcut<T>
Returns void
- Defined in src/keyboard/diagram.keyboard.ts:12

setShortcut

setShortcut(
    mappings: string | string[],
    action: (target: T) => void,
    help?: string,
    action_id?: DiagramActionId,
): void
Parameters
- mappings: string | string[]
- action: (target: T) => void
- Optionalhelp: string
- Optionalaction_id: DiagramActionId
Returns void
- Defined in src/keyboard/diagram.keyboard.ts:19

clear

clear(): void
Returns void
- Defined in src/keyboard/diagram.keyboard.ts:92

getShortcuts

getShortcuts(): KeyboardShortcut<T>[]
Returns KeyboardShortcut<T>[]
- Defined in src/keyboard/diagram.keyboard.ts:96

getShortcut

getShortcut(
    key: string,
    modifiers?: {
        shift?: boolean;
        ctrl?: boolean;
        alt?: boolean;
        meta?: boolean;
    },
): KeyboardShortcut<T>
| undefined
Parameters
- key: string
- modifiers: { shift?: boolean; ctrl?: boolean; alt?: boolean; meta?: boolean } = {}
Returns KeyboardShortcut<T> | undefined
- Defined in src/keyboard/diagram.keyboard.ts:100

getShortcutBySyntax

getShortcutBySyntax(syntax: string): KeyboardShortcut<T> | undefined
Parameters
- syntax: string
Returns KeyboardShortcut<T> | undefined
- Defined in src/keyboard/diagram.keyboard.ts:112

getEventShortcut

getEventShortcut(event: KeyboardEvent): KeyboardShortcut<T> | undefined
Parameters
- event: KeyboardEvent
Returns KeyboardShortcut<T> | undefined
- Defined in src/keyboard/diagram.keyboard.ts:122

invokeEvent

invokeEvent(diagram: T, event: KeyboardEvent): boolean
Parameters
- diagram: T
- event: KeyboardEvent
Returns boolean
- Defined in src/keyboard/diagram.keyboard.ts:151