Class ShortcutManager

constructor

• new ShortcutManager(options?: ShortcutManagerOptions): ShortcutManager

• Parameters

  • options: ShortcutManagerOptions = {}

  Returns ShortcutManager

scope

addCustom

• addCustom(shortcut: CustomShortcut): void

• Parameters

  • shortcut: CustomShortcut

  Returns void

disable

• disable(command: string): void

• Parameters

  • command: string

  Returns void

emitTrigger

• emitTrigger(command: string, combo?: string): void

• Parameters

  • command: string
  • combo: string = ''

  Returns void

handleKey

• handleKey(combo: string): null | string

• Resolve a combo string to a command id (or null).

  Parameters

  • combo: string

  Returns null | string

list

• list(): ShortcutListItem[]

• Returns ShortcutListItem[]

on

• on(cb: (e: ShortcutTriggerEvent) => void): () => void

• Parameters

  • cb: (e: ShortcutTriggerEvent) => void

  Returns () => void

onChange

• onChange(fn: () => void): () => void

• Called after every change to the keymap (a binding set, disabled or reset, a preset, a custom shortcut), so a hint drawn from it can follow. Returns the unsubscriber.

  Parameters

  • fn: () => void

  Returns () => void

resetAll

• resetAll(): void

• Returns void

resetBinding

• resetBinding(command: string): void

• Parameters

  • command: string

  Returns void

resolve

• resolve(event: KeyLike): null | string

• Resolve a keyboard event to a command id (or null).

  Parameters

  • event: KeyLike

  Returns null | string

runCustom

• runCustom(command: string): boolean

• Run a custom command's handler (built-ins are executed by the chart).

  Parameters

  • command: string

  Returns boolean

setBinding

• setBinding(command: string, combo: string | string[]): boolean

• Parameters

  • command: string
  • combo: string | string[]

  Returns boolean

setPreset

• setPreset(preset: ShortcutPreset): void

• Parameters

  • preset: ShortcutPreset

  Returns void

state

• state(): {
      disabled: string[];
      overrides: Record<string, string[]>;
      preset: ShortcutPreset;
  }

• Returns {
      disabled: string[];
      overrides: Record<string, string[]>;
      preset: ShortcutPreset;
  }

StaticshouldIgnore

• shouldIgnore(target: unknown): boolean

• True when a key event targets a text field and should be ignored.

  Parameters

  • target: unknown

  Returns boolean