Shortcut
Used to define a Shortcut as used in Shortcut State
TypeScript
export interface Shortcut extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| Name | string | Name of the Shortcut |
| Scope | ColumnScope<NumberScopeDataType> | Numeric Columns where Shortcut is applied |
| ShortcutKey | string | Key which triggers the Shortcut when pressed |
| ShortcutOperation | 'Add' | 'Subtract' | 'Multiply' | 'Divide' | The Operation: 'Add', 'Subtract', 'Multiply', 'Divide' |
| ShortcutValue | number | Value acting as 2nd operand for ShortcutOperation (1st operand is the cell value) |
| IsReadOnly | boolean | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
| IsSuspended | boolean | Suspends (i.e. turns off) an Adaptable Object |
Property Details
Name
Name of the Shortcut
TypeScript
Name: string;Property Value
string
Scope
Numeric Columns where Shortcut is applied
TypeScript
Scope: ColumnScope<NumberScopeDataType>;Property Value
ColumnScope<NumberScopeDataType>
ShortcutKey
Key which triggers the Shortcut when pressed
TypeScript
ShortcutKey: string;Property Value
string
ShortcutOperation
The Operation: 'Add', 'Subtract', 'Multiply', 'Divide'
TypeScript
ShortcutOperation: 'Add' | 'Subtract' | 'Multiply' | 'Divide';Property Value
'Add' | 'Subtract' | 'Multiply' | 'Divide'
ShortcutValue
Value acting as 2nd operand for ShortcutOperation (1st operand is the cell value)
TypeScript
ShortcutValue: number;Property Value
number
IsSuspended
Inherited from SuspendableObject
Suspends (i.e. turns off) an Adaptable Object
TypeScript
IsSuspended?: boolean;Property Value
boolean
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
TypeScript
IsReadOnly?: boolean;Property Value
boolean