PlusMinusNudge
Defines a Plus Minus Rule - used in the Plus Minus Module
TypeScript
export interface PlusMinusNudge extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| DecrementKey | string | Optional keyboard key that decreases cell values for this nudge only (overrides global decrementKey) |
| IncrementKey | string | Optional keyboard key that increases cell values for this nudge only (overrides global incrementKey) |
| Name | string | Name of the Plus Minus Nudge rule |
| NudgeValue | number | Amount by which to update cell when Rule is applied |
| Rule | AdaptableBooleanQuery | (Optional) Boolean Expression to determine whether to apply the Nudge |
| Scope | ColumnScope<NumberScopeDataType> | Numeric columns where the nudge is applied |
| IsReadOnly | boolean | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
| IsSuspended | boolean | Suspends (i.e. turns off) an Adaptable Object |
Property Details
DecrementKey
Optional keyboard key that decreases cell values for this nudge only (overrides global decrementKey)
TypeScript
DecrementKey?: string;Property Value
string
IncrementKey
Optional keyboard key that increases cell values for this nudge only (overrides global incrementKey)
TypeScript
IncrementKey?: string;Property Value
string
Name
Name of the Plus Minus Nudge rule
TypeScript
Name: string;Property Value
string
NudgeValue
Amount by which to update cell when Rule is applied
TypeScript
NudgeValue: number;Property Value
number
Rule
(Optional) Boolean Expression to determine whether to apply the Nudge
TypeScript
Rule?: AdaptableBooleanQuery;Property Value
Scope
Numeric columns where the nudge is applied
TypeScript
Scope: ColumnScope<NumberScopeDataType>;Property Value
ColumnScope<NumberScopeDataType>
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