Home > @i2analyze/notebook-sdk > commands > ICommandKeyboardHelp > keys

commands.ICommandKeyboardHelp.keys property

Gets the shortcut keys of the command in the keyboard help.

Signature:

readonly keys: string[];

Returns: string[]

Introduced: version 1.0

Remarks

The value of this property is an array of key combinations, to support multiple combinations for a single command.

Each key combination contains one or more machine-readable key names, separated by '+' to mean "at the same time", or a space to mean "in sequence". For example, 'a', 'shift+a', and 'a b c' are all valid key combinations.

The supported modifier keys are 'shift' (as above), 'alt', and 'mod' (which maps to 'ctrl' in Windows and 'meta'/'cmd' in Mac OS).

Some keys are referred to by name instead of the symbol on their keycaps; the full list is: 'backspace', 'tab', 'enter', 'return', 'capslock', 'escape', 'esc', 'space', 'pageup', 'pagedown', 'end', 'home', 'left', 'up', 'right', 'down', 'ins', 'del', 'plus'.

All other keys, including special characters like /, $, *, and =, are referred to by their keycap symbols. In all cases, key combinations are expressed in lowercase letters. For example, it is always shift+e and never E or shift+E.