AlertOptions
Options related to Alerts in Adaptable.
export interfaceProperties
| Property | Description | Default |
|---|---|---|
| alertForms | Full definitions of Alert Forms - the names of which are provided in Alert State | |
| alertMessageHeader | Function providing Header to display in Alert; if empty, AdapTable provides dynamically | |
| alertMessageText | Function providing Message to display in Alert; if empty, AdapTable provides dynamically | |
| cellHighlightDuration | How long (in ms) a Cell will be highlighted when an Alert fires | 2000 |
| commandHandlers | Custom onClick Handlers for Buttons (displayed in Alert Forms) | |
| dataChangeDetectionPolicy | Whether Alert rule is evaluated against the rawValue or formattedValue of the changed cell data | 'rawValue' |
| maxAlertsInStore | How many alerts held in State at any one time; when limit is breached, oldest alert will be removed | 20 |
| rowHighlightDuration | How long (in ms) a Row will be highlighted when an Alert Fires | 4000 |
| showMissingPrimaryKeyAlert | Shows Alert if Primary Key column in Adaptable Options is not present or incorrect | false |
| statusbarHighlightDuration | How long (in ms) Alert panel in Status Bar highlights when an Alert Fires | 2000 |
Property Details
alertForms
Full definitions of Alert Forms - the names of which are provided in Alert State
alertForms?: AlertForm<TData>[];Property Value
AlertForm<TData>[]
alertMessageHeader
Function providing Header to display in Alert; if empty, AdapTable provides dynamically
alertMessageHeader?: (alertMessageContext: AlertMessageContext<TData>) => string | undefined;Property Value
(alertMessageContext:AlertMessageContext<TData>) => string | undefined
alertMessageText
Function providing Message to display in Alert; if empty, AdapTable provides dynamically
alertMessageText?: (alertMessageContext: AlertMessageContext<TData>) => string | undefined;Property Value
(alertMessageContext:AlertMessageContext<TData>) => string | undefined
cellHighlightDuration
How long (in ms) a Cell will be highlighted when an Alert fires
cellHighlightDuration?: number;Default Value
2000
Property Value
number
commandHandlers
Custom onClick Handlers for Buttons (displayed in Alert Forms)
commandHandlers?: CommandHandler<TData>[];Property Value
CommandHandler<TData>[]
dataChangeDetectionPolicy
Whether Alert rule is evaluated against the rawValue or formattedValue of the changed cell data
dataChangeDetectionPolicy?: DataChangeDetectionPolicy;Default Value
'rawValue'
Property Value
maxAlertsInStore
How many alerts held in State at any one time; when limit is breached, oldest alert will be removed
maxAlertsInStore?: number;Default Value
20
Property Value
number
rowHighlightDuration
How long (in ms) a Row will be highlighted when an Alert Fires
rowHighlightDuration?: number;Default Value
4000
Property Value
number
showMissingPrimaryKeyAlert
Shows Alert if Primary Key column in Adaptable Options is not present or incorrect
showMissingPrimaryKeyAlert?: boolean;Default Value
false
Property Value
boolean
statusbarHighlightDuration
How long (in ms) Alert panel in Status Bar highlights when an Alert Fires
statusbarHighlightDuration?: number;Default Value
2000
Property Value
number