Configuring Alerts

One of the Alert Behaviours that can be provided for an Alert is to highlight the Cell which caused the Alert to fire.

This is set in miliseconds and defaults to 2000 (i.e. 2 seconds) but can be changed in this property.

// Set Cells to be Highlighted for 4 seconds when an Alert is fired with behaviour of 'Highlight Cell'
const adaptableOptions: AdaptableOptions = {
  alertOptions: {
    cellHighlightDuration: 4000,
  },
};

One of the Alert Behaviours that can be provided for an Alert is to highlight the Row which contains the Cell that caused the Alert to fire.

This is set in miliseconds and defaults to 4000 (i.e. 4 seconds) but can be changed in this property.

// Set Rows to be Highlighted for 5 seconds when an Alert is fired with behaviour of 'Highlight Row'
const adaptableOptions: AdaptableOptions = {
  alertOptions: {
    rowHighlightDuration: 5000,
  },
};

If the Alert Status Panel has been supplied to the AdapTable Status Bar it will be highlighted when an Alert fires.

The duration of the Highlight defaults to 2000 miliseconds (i.e. 2 seconds) but this can be changed in this property.

// Set Alert Status Panel in Status Bar to be Highlighted for 5 seconds when an Alert is fired
const adaptableOptions: AdaptableOptions = {
  alertOptions: {
    statusbarHighlightDuration: 5000,
  },
};

By default AdapTable will trigger an Alert if the change in a cell's raw value triggers the Rule provided in the Alert Definition.

This can sometimes cause excessive Alerts e.g. if the 5th decimal place in cell value changes for a currency amount which essentially stays the same.

In this case, set this property to formattedValue and the Alert will only trigger if the value displayed in the Cell changes.

// Set Alerts to trigger only when the Cell's Display (and not underlying) value changes
const adaptableOptions: AdaptableOptions = {
  alertOptions: {
    dataChangeDetectionPolicy: 'formattedValue',
  },
};

AdapTable caches Alerts when they are fired in the Grid (as the result of an Alert Definition being triggered).

It will store up to 20 Alerts - so when the limit is breached, the oldest Alert will be removed.

This property can be used to configure for a different number of Alerts to be stored.

// Cache 50 Alerts (instead of default of 20)
const adaptableOptions: AdaptableOptions = {
  alertOptions: {
    maxAlertsInStore: 50,
  },
};