Configuring Alerts
Summary
- Alerts can be provided at design-time through Alert Initial State
- The Alert Options section of Adaptable Options contains many properties for configuring Alert behaviour
Developers are able to provide Alert Definitions and configure Alerts behaviour at design-time.
Alert Definitions
Alert Definitions can be provided in Alert Initial State or created at run-time
This will ensure that the Alerts will fire as necessary each time the Application loads, and that any changes will be stored with Adaptable State.
Alert Options
There are many options in Alert Options that can be set to manage the behaviour of Alerts.
Highlight Duration
Developers can set the highlight durations for Rows, Cells and the Alert Status Bar Panel.
cellHighlightDuration
Default: 2000NumberrowHighlightDuration
Default: 4000NumberstatusbarHighlightDuration
Default: 2000NumberHighlight Style
Note
This defaults to the Alert's MessageType colour but you can provide an Adaptable Style instead
Cell Change Behaviour
Developers can configure the cell change behaviour for triggering Alerts
dataChangeDetectionPolicy
Default: rawValue'rawValue' | 'formattedValue' Number of Alerts Saved
maxAlertsInStore
Default: 20NumberConsolidating Batch Alerts
Sometimes a single action (e.g. Bulk Update, Smart Edit, or gridApi.setCellValues), can updates several cells simultaneously.
By default each cell update will raise a separate Alert.
AdapTable provides an option to consolidate Alerts from the same Definition into one Alert notification — with a count of how many cells triggered it.
consolidateBatchAlerts
Default: truebooleanconsolidateBatchAlertsis true (the default)- An Alert fires on any change to
Github Starsand displays a Notification - The Update 5 Cells button changes the first 5
Github Starsvalues in one batch
- Click Update 5 Cells - Five cells highlight, but the Alert Toolbar / toast shows a single Alert ("5 cells triggered this Alert")