AdapTable provides a number of ways for users to be notified of important events
There are 3 different notification-related Modules available:
|Alert||Highlights all cells in the grid that contain matching query text|
|Flashing Alert||Runs real-time text-based queries using the rich and powerful AdapTableQL|
|System Status||Updates the entire data set in AdapTable using pre-populated data sources|
Options for managing Notifications in AdapTable.
|actionHandlers||onClick Handlers for Alert Buttons (defined in Alert State)|
|alertForms||Full definitions of Alert Forms - the names of which are provided in Alert State|
|cellHighlightDuration||How long (in ms) a cell will be highlighted||3000|
|closeWhenClicked||Closes Notification automatically when its clicked||false|
|dataChangeDetectionPolicy||Whether Alert rule is evaluated against the ||'rawValue'|
|duration||How long (in ms) Notifications display for||3000|
|flashingAlertDefaultProperties||Flashing Alert Defaults||BackColors: Green (up), Red (down), Gray (neutral), Duration: 500ms|
|isDraggable||Can Notification be dragged||false|
|maxAlertsInStore||How many alerts held in State at any one time; when limit is breached, oldest alert will be removed||20|
|maxNotifications||How many Notifications can be displayed at one time||3|
|maxSystemMessagesInStore||How many System Status Messages to hold in State; when limit is reached, oldest Message is removed||100|
|pauseWhenHovering||Pauses the Notification when mouse hovers over it||false|
|position||Where Notification will appear (if anywhere)||'BottomRight'|
|showProgressBar||Shows a Progress Bar in the Notification||false|
|showSystemStatusMessageAsAlert||Display an Alert when a System Status Message is set||false|
|transition||How Notification will appear: 'Bounce', 'Slide', 'Zoom' or 'Flip'||'Slide'|
Most of the Notifications Options properties relate to the appearance of the Notification that can be displayed in AdapTable at various times (e.g. when an Alert is triggered, or a Message needs to be displayed).
By default the Notification will appear by sliding into the BottomRight of the screen for 3 seconds without a progress bar and cannot be dragged nor will close when it is clicked.
However all these settings are fully configurable.
Unlike Alert Properties which can be set independently for each Alert Definition, Notifications are set in Alert Options and so are configured identically for every Alert which displays a notification
There are 3 notification based Adaptable Events.
This fires whenever an Alert is triggered in AdapTable.
The AlertFiredInfo describes the Alert that has been fired - this will contain details of the Alert Definition that triggered the Alert, and (optionally) what Data Change was responsible.
|alert||Alert which has been fired|
Flashing Alert Fired
This fires whenever a Flashing Alert is triggered in AdapTable.
The FlashingAlertFiredInfo describes the Flashing Alert which was fired.
|flashingAlert||FlashingAlert which has been fired|
flashingAlert property is of object type AdaptableFlashingAlert defined as follows:
|dataChangedInfo||Data change which triggered the FlashingAlert|
|direction||Direction of the change: 'up', 'down' or 'neutral'|
|flashColumnIds||Column Ids that are flashing|
|flashingAlertDefinition||Rule that caused the FlashingAlert to fire|
|flashTarget||What will flash (e.g. Cell, Row)|
|rowPrimaryKey||Primary Key Value of Row which is flashing|
System Status Message Displayed
This fires whenever a System Status Message is displayed.
The event provides a SystemStatusMessageDisplayedInfo object defined as follows.
|systemStatusMessageInfo||Details of the System Status Message and Type|
This contains a SystemStatusMessageInfo object with these properties:
|statusFurtherInformation||Additional information to display (optional)|
|statusMessage||The Message to be displayed|
|statusType||Type of Message i.e. Succcess, Warning, Error, Info|
|timestamp||When Message was sent|
Subscribing to the Events is done the same as with all Adaptable Events: