FlashingCellDefinition

View as Markdown

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.

TypeScript
export interface FlashingCellDefinition extends AdaptableObject,
Extends

AdaptableObject, SuspendableObject

Properties

PropertyTypeDescriptionDefault
DownChangeStyleAdaptableStyleStyle for 'Down' value changesRed BackColour
FlashDurationnumber | 'always'Duration of Flash - can be number (in ms) or 'always'500ms
FlashTargetFlashTargetTypes|FlashTargetTypes[]Should a cell or whole row flash'cell'
NamestringName of the Flashing Cell Definition
NeutralChangeStyleAdaptableStyleStyle for 'Neutral' value changesGray BackColour
RulestringAdapTableQL 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
ScopeColumnScopeWhich Columns, DataTypes or Column Types can Flash
TypeFlashingCellType'Change' compares this edit with the previous value. 'Observable' evaluates the rule against change history. When omitted, the definition is treated as 'Change'.
UpChangeStyleAdaptableStyleStyle for 'Up' value changesGreen BackColour
IsReadOnlybooleanSets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsSuspendedbooleanSuspends (i.e. turns off) an Adaptable Object

Property Details

DownChangeStyle

Style for 'Down' value changes

TypeScript
DownChangeStyle?: AdaptableStyle;
Default Value

Red BackColour

Property Value

AdaptableStyle

FlashDuration

Duration of Flash - can be number (in ms) or 'always'

TypeScript
FlashDuration?: number | 'always';
Default Value

500ms

Property Value

number | 'always'

FlashTarget

Should a cell or whole row flash

TypeScript
FlashTarget?: FlashTargetTypes | FlashTargetTypes[];
Default Value

'cell'

Property Value

FlashTargetTypes|FlashTargetTypes[]

Name

Name of the Flashing Cell Definition

TypeScript
Name: string;
Property Value

string

NeutralChangeStyle

Style for 'Neutral' value changes

TypeScript
NeutralChangeStyle?: AdaptableStyle;
Default Value

Gray BackColour

Property Value

AdaptableStyle

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

TypeScript
Rule: string;
Property Value

string

Scope

Which Columns, DataTypes or Column Types can Flash

TypeScript
Scope: ColumnScope;
Property Value

ColumnScope

Type

'Change' compares this edit with the previous value. 'Observable' evaluates the rule against change history. When omitted, the definition is treated as 'Change'.

TypeScript
Type?: FlashingCellType;
Property Value

FlashingCellType

UpChangeStyle

Style for 'Up' value changes

TypeScript
UpChangeStyle?: AdaptableStyle;
Default Value

Green BackColour

Property Value

AdaptableStyle

IsReadOnly

Inherited from AdaptableObject

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

TypeScript
IsReadOnly?: boolean;
Property Value

boolean

IsSuspended

Inherited from SuspendableObject

Suspends (i.e. turns off) an Adaptable Object

TypeScript
IsSuspended?: boolean;
Property Value

boolean