Flashing Cell Technical Reference
Summary
- Flashing Cells can be defined in Initial Adaptable State and also configured in Adaptable Options
- Run-time access is provided through Flashing Cell API
- The Flashing Cell Displayed Event fires when a cell or row flashes
Flashing Cell State
The Flashing Cell section of Initial State contains a collection of FlashingCellDefinition objects:
| Property | Type | Description |
|---|---|---|
| FlashingCellDefinitions | FlashingCellDefinition[] | Flashing Cell Definitions - will flash cells/rows when rule is met |
Flashing Cell Definition
Each Flashing Cell Definition is defined as follows:
| Property | Type | Description | Default |
|---|---|---|---|
| DownChangeStyle | AdaptableStyle | Style for 'Down' value changes | Red BackColour |
| FlashDuration | number | 'always' | Duration of Flash - can be number (in ms) or 'always' | 500ms |
| FlashTarget | FlashTargetTypes | FlashTargetTypes[] | Should a cell or whole row flash | 'cell' |
| Name | string | Name of the Flashing Cell Definition | |
| NeutralChangeStyle | AdaptableStyle | Style for 'Neutral' value changes | Gray BackColour |
| Rule | FlashingCellRule | When Flashing Cell should be triggered | |
| Scope | ColumnScope | Which Columns, DataTypes or Column Types can Flash | |
| UpChangeStyle | AdaptableStyle | Style for 'Up' value changes | Green BackColour |
| IsReadOnly | boolean | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') | |
| IsSuspended | boolean | Suspends (i.e. turns off) an Adaptable Object |
Flashing Cell Options
The Flashing Cell Options section of Adaptable Options contains Flashing Cell properties:
| Property | Type | Description | Default |
|---|---|---|---|
| defaultDownChangeStyle | AdaptableStyle | Style for 'Down' value changes | Red BackColour |
| defaultFlashDuration | number | 'always' | Duration of Flash - can be number (in ms) or 'always' | 500ms |
| defaultFlashTarget | FlashTarget | Should a cell or whole row flash | 'cell' |
| defaultNeutralChangeStyle | AdaptableStyle | Style for 'Neutral' value changes | Gray BackColour |
| defaultUpChangeStyle | AdaptableStyle | Style for 'Up' value changes | Green BackColour |
Flashing Cell API
The Flashing Cell API section of Adaptable API contains numerous functions.
They include functions to turn Cell Flashing off and on programmatically, and for Rules to be accessed, created, edited, deleted, suspended and shared.
| Method | Returns | Description |
|---|---|---|
| addFlashingCellDefinition(flashingCellDefinition) | FlashingCellDefinition | Adds a Flashing Cell Definition to State |
| addFlashingCellDefinitions(flashingCellDefinitions) | FlashingCellDefinition[] | Adds provided Flashing Cell Definitions |
| clearAllFlashingCells() | void | Clears all Cells and Rows which have been flashed (primarily used if duration is 'Always') |
| deleteFlashingCellDefinition(flashingCellDefinition) | void | Deletes a Flashing Cell |
| editFlashingCellDefinition(flashingCellDefinition) | FlashingCellDefinition | Edits Flashing Cell Definition in State with given one |
| editFlashingCellDefinitions(flashingCellDefinitions) | FlashingCellDefinition[] | Edits provided Flashing Cell Definitions |
| findFlashingCellDefinitions(flashingCellLookupCriteria) | FlashingCellDefinition[] | Find all Flashing Cell Definitions which match the given criteria |
| getActiveFlashingCellDefinitions(config) | FlashingCellDefinition[] | Retrieves all active (non-suspended) cell Definitions in Flashing Cell State |
| getFlashingCellDefinitionById(id, config) | FlashingCellDefinition | Retrieves Flashing Cell Definition by the technical ID (from FlashingCellState) |
| getFlashingCellDefinitionByName(name) | FlashingCellDefinition | undefined | Retrieves a Flashing Cell Definition by its Name |
| getFlashingCellDefinitions(config) | FlashingCellDefinition[] | Retrieves all Flashing Cell Definitions in Flashing Cell State |
| getFlashingCellFlashTarget(flashingCellDefinition) | FlashingCellDefinition['FlashTarget'] | Returns FlashTarget of the given Flashing Cell Definition |
| getFlashingCellPredicateDefsForScope(scope) | AdaptablePredicateDef[] | Retrieves all Predicate Defs that match given Scope |
| getFlashingCellState() | FlashingCellState | Retrieves Flashing Cell section from Adaptable State |
| getSuspendedFlashingCellDefinitions(config) | FlashingCellDefinition[] | Retrieves all suspended Cell Definitions in Flashing Cell State |
| isAnyFlashingCellActive() | boolean | Is there any cells/rows currently being flashed |
| setFlashingCellDefinitions(flashingCellDefinitions) | void | Sets a collection of Flashing Cell Definitions into State |
| showFlashingCell(flashingCellToShow) | void | Evaluates the given Flashing Cell Definition and flashes the correspondent cells/rows |
| suspendAllFlashingCellDefinition() | void | Suspends all FlashingCell Definitions |
| suspendFlashingCellDefinition(flashingCellDefinition) | FlashingCellDefinition | Suspends a Flashing Cell Definition |
| unSuspendAllFlashingCellDefinition() | void | Activates all suspended Flashing Cell Definition |
| unSuspendFlashingCellDefinition(flashingCellDefinition) | FlashingCellDefinition | Activates a suspended Flashing Cell Definition |
Flashing Cell Displayed Event
The FlashingCellDisplayedEvent fires when a Cell or Row has flashed.
EventInfo
The Flashing Cell Displayed Event has a FlashingCellDisplayedInfo object which contains one property:
| Property | Type | Description |
|---|---|---|
| flashingCell | AdaptableFlashingCell | Details of the Cell (or row) which has just flashed |
| adaptableContext | any | Custom application Context provided in AdaptableOptions.adaptableContext |
This flashingCell property is of type AdaptableFlashingCell defined as follows:
| Property | Type | Description |
|---|---|---|
| cellDataChangedInfo | CellDataChangedInfo | Data change which triggered the FlashingCell |
| direction | 'up' | 'down' | 'neutral' | Direction of the change: 'up', 'down' or 'neutral' |
| flashColumnIds | Record<string, boolean> | Column Ids that are flashing |
| flashingCellDefinition | FlashingCellDefinition | Rule that caused the FlashingCell to fire |
| flashTarget | FlashingCellDefinition['FlashTarget'] | What will flash (e.g. Cell, Row) |
| rowPrimaryKey | string | Primary Key Value of Row which is flashing |
Event Subscription
Subscribing to the Events is done the same as with all Adaptable Events:
api.eventApi.on('FlashingCellDisplayed', (eventInfo: FlashingCellDisplayedInfo) => {
// do something with the info
});