Plus Minus Technical Reference
Summary
- Plus Minus State contains the Plus Minus Rules
- Programmatic access to Plus Minus is through Plus Minus API
Plus Minus State
Plus Minus State contains a collection of Plus Minus Rules:
| Property | Type | Description |
|---|---|---|
| PlusMinusNudges | PlusMinusNudge[] | Array of Plus Minus Nudges |
Plus Minus
A Plus Minus Nudge is defined as follows:
| 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 |
Plus Minus API
The Plus Minus API section of Adaptable API enables Plus / Minus Rules to be configured at run-time
| Method | Returns | Description |
|---|---|---|
| addPlusMinusNudge(plusMinusNudge) | PlusMinusNudge | Adds new Plus Minus Rule to State |
| applyPlusMinus(cellUpdateRequests) | void | Applies a Plus Minus to given cells |
| deletePlusMinusNudge(plusMinusNudge) | void | Deletes a plus minus rule |
| editPlusMinusNudge(plusMinusNudge) | PlusMinusNudge | Replaces Plus Minus Rule in State with given one |
| getAllActivePlusMinus(config) | PlusMinusNudge[] | Retrieves all active (not-suspended) Plus Minus Rules in Adaptable State with those with expressions first |
| getAllPlusMinus(config) | PlusMinusNudge[] | Retrieves all Plus Minus Rules in Adaptable State with those with expressions first |
| getAllSuspendedPlusMinus(config) | PlusMinusNudge[] | Retrieves all suspended Plus Minus Rules in Adaptable State with those with expressions first |
| getPlusMinusById(id, config) | PlusMinusNudge | Retrieves Plus Minus Rule by the technical ID (from PlusMinusState) |
| getPlusMinusNudgeByName(name) | PlusMinusNudge | undefined | Retrieves a Plus Minus Nudge by its Name |
| getPlusMinusState() | PlusMinusState | Retrieves Plus Minus section from Adaptable State (nudge rules only). Keyboard triggers are optional on each ; unset fields fall back to AdaptableOptions.plusMinusOptions, then + / -. |
| openPlusMinusSettingsPanel() | void | Opens Settings Panel with Plus Minus section selected and visible |
| runPlusMinusNudge(plusMinusNudge, cells, direction) | void | Applies a Plus Minus Rule to given cells |
| suspendPlusMinusNudge(plusMinusNudge) | PlusMinusNudge | Suspends Plus Minus Rule |
| unSuspendPlusMinusNudge(plusMinusNudge) | PlusMinusNudge | Activates a suspended Plus Minus Rule |