UpdatedRowState

Predefined Configuration for Updated Row Function

TypeScript
export interface UpdatedRowState extends ConfigState
Extends

ConfigState

Properties

PropertyDescriptionDefault
DownColorDefault colour to use when numeric or date cell that triggered the update had down data changered
DurationHow long Updated Row will show colour; not currently used, so value is 'Always' - row updates remain in place until cleared
EnableUpdatedRowEnables the Updated Row function so rows where data changes are highlightedfalse
JumpToRowAdaptable will jump to display updated rowfalse
MaxUpdatedRowsInStoreMaximum number of updated rows to hold in State - and therefore to displayInfinity
NeutralColorDefault colour to use when cell that triggered the update had no directional data changegray
UpColorDefault colour to use when numeric or date cell that triggered the update had up data changegreen

Property Details

DownColor

Default colour to use when numeric or date cell that triggered the update had down data change

TypeScript
DownColor?: string;
Default Value

red

Property Value

string

Duration

How long Updated Row will show colour; not currently used, so value is 'Always' - row updates remain in place until cleared

TypeScript
Duration?: 250 | 500 | 750 | 1000 | 'Always';
Property Value

250 | 500 | 750 | 1000 | 'Always'

EnableUpdatedRow

Enables the Updated Row function so rows where data changes are highlighted

TypeScript
EnableUpdatedRow?: boolean;
Default Value

false

Property Value

boolean

JumpToRow

Adaptable will jump to display updated row

TypeScript
JumpToRow?: boolean;
Default Value

false

Property Value

boolean

MaxUpdatedRowsInStore

Maximum number of updated rows to hold in State - and therefore to display

TypeScript
MaxUpdatedRowsInStore?: number;
Default Value

Infinity

Property Value

number

NeutralColor

Default colour to use when cell that triggered the update had no directional data change

TypeScript
NeutralColor?: string;
Default Value

gray

Property Value

string

UpColor

Default colour to use when numeric or date cell that triggered the update had up data change

TypeScript
UpColor?: string;
Default Value

green

Property Value

string