Listening to Alerts

Summary

Event published by AdapTable whenever an Alert has been triggered by AdapTable
Provides details of the Alert that fired and the Alert Definition that triggered it

The Alert Fired Event is published by AdapTable whenever an Alert is fired.

The EventInfo includes full details of the Alert Definition that triggered the Alert, the Change that occurred in AG Grid and other related information.

The Change that can be triggered the Alert can be one of 2 types:

Cell Change - the value of a Cell has changed
Row Change - a row has been added, updated, or deleted

Deep Dive

Understanding the Alert Fired Event

AlertFiredInfo

The event comprises the AlertFiredInfo object which contains a single property:

Property	Description
alert	Alert which has been fired
adaptableContext	Custom application Context provided in `AdaptableOptions.adaptableContext`

This is of type AdaptableAlert which has 2 flavours:

Cell Changed Alert
Row Changed Alert.

Cell Changed Alert

This is fired when a Cell in AdapTable is changed - either manually or via ticking data.

It is of type AdaptableCellChangedAlert and contains a single cellDataChangedInfo property:

Property	Description
cellDataChangedInfo	Cell DataChange which triggered Alert

This property is of type CellDataChangedInfo and contains full details of the Cell Change:

Property	Description
changedAt	Timestamp of change occurrence (in milliseconds)
column	Column in which cell is situated
newValue	New value for the cell
oldValue	Value in the Cell before the edit
primaryKeyValue	Primary Key Column's value for the row where edited cell is situated
rowData	Data in the Row
rowNode	AG Grid RowNode that contains the cell
trigger	What triggered the change - user, background change or a reverted change?

Row Changed Alert

This is fired when a Row in AdapTable has been added, updated or deleted.

It is of type AdaptableRowChangedAlert and contains a single rowDataChangedInfo property:

Property	Description
rowDataChangedInfo	Row DataChange which triggered Alert

This property is of type RowDataChangedInfo and contains full details of the Row in question:

Property	Description
changedAt	Timestamp of change occurrence (in milliseconds)
dataRows	Data rows that have been added, updated, or deleted
rowNodes	Row Nodes that were affected by this change
rowTrigger	Trigger for row change: Load, Add, Update, or Delete

Event Subscription

Subscribing to the Event is done the same way as with all Adaptable Events:

api.eventApi.on('AlertFired', (eventInfo: AlertFiredInfo) => {
    // do something with the info
});

Events: Alert Fired

Fork Fork

This Demo listens to the Alert Fired Event and sends details as a System Status Message. There are 2 Alerts:
- Cell Changed: Error Alert if GitHub Stars Column is LessThan 1000
- Row Changed: Warning Alert when a Row is deleted

Try It Out

Trigger Alerts and then see how the Alert Fired Event is handled by:
- Editing a cell in the GitHub Stars Column to a value <1000
- Clicking the Delete Row Button

import {AdaptableOptions} from '@adaptabletools/adaptable';
import {WebFramework} from './rowData';

export const adaptableOptions: AdaptableOptions<WebFramework> = {
  primaryKey: 'id',
  adaptableId: 'Alert Fired Event Demo',
  actionColumnOptions: {
    actionColumns: [
      {
        columnId: 'action',
        friendlyName: 'Delete',
        actionColumnButton: {
          command: 'delete',
        },
      },
    ],
  },
  initialState: {
    Dashboard: {
      ModuleButtons: ['Alert'],
      Tabs: [
        {
          Name: 'Toolbars',
          Toolbars: ['Alert', 'SystemStatus'],
        },
      ],
    },
    StatusBar: {
      StatusBars: [
        {
          Key: 'Center Panel',
          StatusBarPanels: ['Alert', 'SystemStatus'],
        },
      ],
    },
    Theme: {CurrentTheme: 'dark'},
    Alert: {
      AlertDefinitions: [
        {
          Name: 'alert-error-github-stars',
          MessageType: 'Error',
          Scope: {
            ColumnIds: ['github_stars'],
          },
          Rule: {
            Predicates: [
              {
                PredicateId: 'LessThan',
                Inputs: [1000],
              },
            ],
          },
          AlertProperties: {
            HighlightCell: true,
            DisplayNotification: true,
          },
        },
        {
          Name: 'alert-warning-row-removed',
          Rule: {
            ObservableExpression: 'ROW_REMOVED()',
          },
          MessageType: 'Warning',
          MessageHeader: 'You removed a row',
          MessageText: 'Hey! A row was removed',
          Scope: {
            All: true,
          },
          AlertProperties: {
            DisplayNotification: true,
          },
        },
      ],
    },
    Layout: {
      CurrentLayout: 'Standard Layout',
      Layouts: [
        {
          Name: 'Standard Layout',
          TableColumns: [
            'action',
            'name',
            'language',
            'github_stars',
            'license',
            'open_issues_count',
            'description',
            'created_at',
            'has_wiki',
            'updated_at',
            'pushed_at',
            'github_watchers',
          ],
          AutoSizeColumns: true,
        },
      ],
    },
  },
};

PreviousConfiguring Alerts NextTechnical Reference

Framework: