Class KeyboardShortcutController

Registers the viewer's KeyboardShortcuts, listens to keyboard events on the window and executes the matching shortcut, including continuous-hold repetition.

Index

Constructors

Properties

Accessors

Methods

addShortcut dispose enableShortcut removeShortcut setBinding

Constructors

constructor

new KeyboardShortcutController(viewer: Viewer): KeyboardShortcutController
Parameters
- viewer: Viewer
Returns KeyboardShortcutController
- Defined in packages/viewer/src/viewport/keyboard/KeyboardShortcutController.ts:97

Properties

`Readonly`signals

signals: { onShortcutsChanged: Signal<(...args: any[]) => any> } = ...

Accessors

shortcuts

get shortcuts(): MapIterator<KeyboardShortcut>
Returns MapIterator<KeyboardShortcut>
- Defined in packages/viewer/src/viewport/keyboard/KeyboardShortcutController.ts:118

Methods

addShortcut

addShortcut(shortcut: KeyboardShortcut): void
Parameters
- shortcut: KeyboardShortcut
Returns void
- Defined in packages/viewer/src/viewport/keyboard/KeyboardShortcutController.ts:223

dispose

dispose(): void
Returns void
- Defined in packages/viewer/src/viewport/keyboard/KeyboardShortcutController.ts:110

enableShortcut

enableShortcut(action: keyof KeyboardShortcutRegistry, enable?: boolean): void
Parameters
- action: keyof KeyboardShortcutRegistry
- enable: boolean = true
Returns void
- Defined in packages/viewer/src/viewport/keyboard/KeyboardShortcutController.ts:240

removeShortcut

removeShortcut(shortcut: KeyboardShortcut): boolean
Parameters
- shortcut: KeyboardShortcut
Returns boolean
- Defined in packages/viewer/src/viewport/keyboard/KeyboardShortcutController.ts:231

setBinding

setBinding(
action: keyof KeyboardShortcutRegistry,
binding: KeyboardShortcutKeyBinding,
): void
Parameters
- action: keyof KeyboardShortcutRegistry
- binding: KeyboardShortcutKeyBinding
Returns void
- Defined in packages/viewer/src/viewport/keyboard/KeyboardShortcutController.ts:252