RowChangeAlertDefinition

Alert that fires when a row is added to or removed from the grid.

Set Type to 'RowChange' and RowChangeTrigger to 'Added' or 'Removed'. Scope is { All: true }. Rule is an optional per-row boolean expression ([make] = 'Toyota'); when it is omitted every matching row event fires.

export interface RowChangeAlertDefinition extends

Extends

AlertDefinitionBase

Properties

Property Details

AlertForm

Form to display in Alert with buttons and inputs

AlertForm?: string | AlertButtonForm;

Property Value

string |AlertButtonForm

AlertProperties

Properties which set what happens when the Alert is triggered (notification and grid behaviours)

AlertProperties?: RuleAlertProperties;

Property Value

RuleAlertProperties

RowChangeTrigger

Which row event fires the Alert.

RowChangeTrigger: 'Added' | 'Removed';

Property Value

'Added' | 'Removed'

Rule

Optional boolean expression evaluated on the added / removed row; when absent every row event fires.

Rule?: string;

Property Value

string

Scope

Kept for uniformity with the other grid Alerts; Row Change Alerts apply to the whole row ({ All: true }).

Scope: ColumnScope;

Property Value

ColumnScope

Type

Type: 'RowChange';

Property Value

'RowChange'

IsSuspended

Inherited from SuspendableObject

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

IsSuspended?: boolean;

Property Value

boolean

IsReadOnly

Inherited from AdaptableObject

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

IsReadOnly?: boolean;

Property Value

boolean