Options
All
  • Public
  • Public/Protected
  • All
Menu

The Predefined Configuration for the Alert function

Alerts will notify you when something changes that you do need to be notified about (based on an Alert Definition).

This can be either the result of an edit the user makes, or it can be ticking data.

You can select the type of the Alert (e.g. Success, Warning, Error etc.) and where it appears.

Further Resources

Alert Help

Alert Videos

Alert Demo

Alert Blotter API

Alert FAQ

Alert Predefined Config Example

export default {
Alert: {
   MaxAlertsInStore: 10,
   AlertDefinitions: [
   {
     ColumnId: 'InvoicedCost',
     MessageType: 'Warning',
     Range: {
       Operand1: '2000',
       Operand1Type: 'Value',
       Operand2: '',
       Operand2Type: 'Value',
       Operator: 'GreaterThan',
     },
     ShowAsPopup: true,
   },
   {
     ColumnId: 'ItemCount',
     MessageType: 'Info',
     Range: {
       Operand1: '100',
       Operand1Type: 'Value',
       Operand2: '',
       Operand2Type: 'Value',
       Operator: 'PercentChange',
     },
     ShowAsPopup: false,
    },
  ],
},
} as PredefinedConfig;

In this example we have created 2 Alert Definitions:

  • On the InvoicedCost column which will warn (and show a popup) when the value is > 2000 (and display a popup).

  • On the ItemCount column which will show info alert (but not show a popup) if the new value is more than double (i.e. has percent change > 100).

Hierarchy

Index

Properties

Optional AlertDefinitions

AlertDefinitions: AlertDefinition[]

A collection of Alert Definitions - which will trigger Alerts when their condition is met

Default Value: Empty array

Optional AlertPopupDiv

AlertPopupDiv: string

The name of the div in which you want the alerts to display.

Leave blank if you want them to show using the main Adaptable Blotter popup.

This property is only used if the Alert itself has showAsPopup set to true.

Default Value: Empty string

Optional MaxAlertsInStore

MaxAlertsInStore: number

How many alerts to hold in the State at any one time. If you reacch this limit then we remove the oldest alert each time a new one is triggered.

Default Value: 20

Generated using TypeDoc