FlashingCellDefinition
Flashes a cell, a row, or an aggregated cell when a rule matches.
Scope and Rule are required. Type is 'Change' (this edit against the previous value) or 'Observable' (change history such as CHANGE_COUNT). When Type is omitted it is treated as 'Change'. Suspend with IsSuspended.
export interface FlashingCellDefinition extends AdaptableObject,Extends
AdaptableObject, SuspendableObject
Properties
| 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 | string | AdapTableQL boolean expression deciding when the Flashing Cell is triggered (evaluated per data change for Change; against live history for Observable), e.g. ANY_CHANGE([price]) or CHANGE_COUNT{[price], WITHIN(5m)} > 3 | |
| Scope | ColumnScope | Which Columns, DataTypes or Column Types can Flash | |
| Type | FlashingCellType | 'Change' compares this edit with the previous value. 'Observable' evaluates the rule against change history. When omitted, the definition is treated as 'Change'. | |
| 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 |
Property Details
DownChangeStyle
Style for 'Down' value changes
DownChangeStyle?: AdaptableStyle;Default Value
Red BackColour
Property Value
FlashDuration
Duration of Flash - can be number (in ms) or 'always'
FlashDuration?: number | 'always';Default Value
500ms
Property Value
number | 'always'
FlashTarget
Should a cell or whole row flash
FlashTarget?: FlashTargetTypes | FlashTargetTypes[];Default Value
'cell'
Property Value
FlashTargetTypes|FlashTargetTypes[]
Name
Name of the Flashing Cell Definition
Name: string;Property Value
string
NeutralChangeStyle
Style for 'Neutral' value changes
NeutralChangeStyle?: AdaptableStyle;Default Value
Gray BackColour
Property Value
Rule
AdapTableQL boolean expression deciding when the Flashing Cell is triggered
(evaluated per data change for Change; against live history for Observable),
e.g. ANY_CHANGE([price]) or CHANGE_COUNT{[price], WITHIN(5m)} > 3
Rule: string;Property Value
string
Scope
Which Columns, DataTypes or Column Types can Flash
Scope: ColumnScope;Property Value
Type
'Change' compares this edit with the previous value. 'Observable' evaluates the rule against change history. When omitted, the definition is treated as 'Change'.
Type?: FlashingCellType;Property Value
UpChangeStyle
Style for 'Up' value changes
UpChangeStyle?: AdaptableStyle;Default Value
Green BackColour
Property Value
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsReadOnly?: boolean;Property Value
boolean
IsSuspended
Inherited from SuspendableObject
Suspends (i.e. turns off) an Adaptable Object
IsSuspended?: boolean;Property Value
boolean