ShortcutApi

Provides run-time access to Shortcut Module and associated state

TypeScript

export interface

Methods

Method	Returns	Description
addShortcut(shortcut)	`Shortcut`	Adds new Shortcut to the state
deleteShortcut(shortcut)	`void`	Deletes Shortcut from the state
editShortcut(shortcut)	`Shortcut`	Edits Shortcut in state
getActiveShortcuts(config)	`Shortcut[]`	Gets all active (not-suspended) Shortcuts in Adaptable State
getShortcutById(id, config)	`Shortcut`	Retrieves Shortcut by Id
getShortcutByName(name)	`Shortcut` `\| undefined`	Retrieves a Shortcut by its Name
getShortcuts(config)	`Shortcut[]`	Gets all Shortcuts in Adaptable State
getShortcutState()	`ShortcutState`	Retrieves Shortcut section from Adaptable State
getSuspendedShortcuts(config)	`Shortcut[]`	Gets all suspended Shortcuts in Adaptable State
openShortcutSettingsPanel()	`void`	Opens Settings Panel with Shortcut section selected and visible
suspendAllShortcut()	`void`	Suspends all Shortcuts
suspendShortcut(shortcut)	`Shortcut`	Suspends Shortcut definition
unSuspendAllShortcut()	`void`	Activates all suspended Shortcut
unSuspendShortcut(shortcut)	`Shortcut`	Activates a suspended Shortcut definition

Method Details

addShortcut

Adds new Shortcut to the state

TypeScript

addShortcut(shortcut: Shortcut): Shortcut;

Parameters

Parameter	Type	Description
shortcut	`Shortcut`	Shortcut to add

Returns

Shortcut

deleteShortcut

Deletes Shortcut from the state

TypeScript

deleteShortcut(shortcut: Shortcut): void;

Parameters

Parameter	Type	Description
shortcut	`Shortcut`	Shortcut to delete

Returns

void

editShortcut

Edits Shortcut in state

TypeScript

editShortcut(shortcut: Shortcut): Shortcut;

Parameters

Parameter	Type	Description
shortcut	`Shortcut`	Shortcut to edit

Returns

Shortcut

getActiveShortcuts

Gets all active (not-suspended) Shortcuts in Adaptable State

TypeScript

getActiveShortcuts(config?: LayoutExtendedConfig): Shortcut[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

Shortcut[]

getShortcutById

Retrieves Shortcut by Id

TypeScript

getShortcutById(id: Shortcut['Uuid'], config?: LayoutExtendedConfig): Shortcut;

Parameters

Parameter	Type	Description
id	`Shortcut['Uuid']`	Shortcut id
config	`LayoutExtendedConfig`

Returns

Shortcut

getShortcutByName

Retrieves a Shortcut by its Name

TypeScript

getShortcutByName(name: string): Shortcut | undefined;

Parameters

Parameter	Type	Description
name	`string`	Name of the Shortcut

Returns

Shortcut | undefined

getShortcuts

Gets all Shortcuts in Adaptable State

TypeScript

getShortcuts(config?: LayoutExtendedConfig): Shortcut[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

Shortcut[]

getShortcutState

Retrieves Shortcut section from Adaptable State

TypeScript

getShortcutState(): ShortcutState;

Returns

ShortcutState

getSuspendedShortcuts

Gets all suspended Shortcuts in Adaptable State

TypeScript

getSuspendedShortcuts(config?: LayoutExtendedConfig): Shortcut[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

Shortcut[]

openShortcutSettingsPanel

Opens Settings Panel with Shortcut section selected and visible

TypeScript

openShortcutSettingsPanel(): void;

Returns

void

suspendAllShortcut

Suspends all Shortcuts

TypeScript

suspendAllShortcut(): void;

Returns

void

suspendShortcut

Suspends Shortcut definition

TypeScript

suspendShortcut(shortcut: Shortcut): Shortcut;

Parameters

Parameter	Type	Description
shortcut	`Shortcut`	Shortcut to suspend

Returns

Shortcut

unSuspendAllShortcut

Activates all suspended Shortcut

TypeScript

unSuspendAllShortcut(): void;

Returns

void

unSuspendShortcut

Activates a suspended Shortcut definition

TypeScript

unSuspendShortcut(shortcut: Shortcut): Shortcut;

Parameters

Parameter	Type	Description
shortcut	`Shortcut`	Shortcut to suspend

Returns

Shortcut

PreviousShortcut NextShortcutState