FlashingCellDefinition
The Flashing Cell Definition
TypeScript
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 | 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 |
Property Details
DownChangeStyle
Style for 'Down' value changes
TypeScript
DownChangeStyle?: AdaptableStyle;Default Value
Red BackColour
Property Value
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
Rule
When Flashing Cell should be triggered
TypeScript
Rule: FlashingCellRule;Property Value
FlashingCellRule
Scope
Which Columns, DataTypes or Column Types can Flash
TypeScript
Scope: ColumnScope;Property Value
UpChangeStyle
Style for 'Up' value changes
TypeScript
UpChangeStyle?: AdaptableStyle;Default Value
Green BackColour
Property Value
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