OpenFin Technical Reference
OpenFin Plugin Options
OpenFinPluginOptions
Options required for when using the OpenFin plugin
number | false
Timeout (in ms) for OpenFin Notifications to expire; set false for notifications not to auto-dismiss
5000
(event: { notification: any; type: string; trigger: string; result: { task: string; }; }) => any
Function which is invoked when a button in OpenFin notification is clicked
(notification: any, alert?:AdaptableAlert) => any
Updates OpenFin Notification object before it's displayed (just add/remove properties); return false to stop Notification showing
'override' | 'show-notification' | 'show-undo-notification'
Action to perform when a data change in Live Excel report triggers Prevent Edit Alert failure
Converts AdapTable Alerts configured to display in popup as OpenFin Notifications
true
Icon to show in Notification - uses the value supplied in UserInterfaceOptions
true
number
How long (in ms) AdapTable throttles when sending data update to OpenFin
2000
OpenFin API
Caution
Some of these methods are intended for internal use only - and have been marked as such
OpenFinApi
The OpenFin plugin: notifications, and starting or stopping live data.
OpenFinReport | undefined
Retrieves the OpenFin currently sending live data to Excel
OpenFinState | undefined
Retrieves the OpenFin section of System State
number | undefined
Retrieves the Throttle time for live updates
Retrieves the OpenFinPlugOptions provided in OpenFin Plugin
boolean
Whether OpenFin is currently running
void
Shows a notification in OpenFin
void
Displays Alert as an OpenFin Notification
void
Runs Report in Excel as Live Report (so updates as AdapTable ticks)
void
Stops live data; data will no longer be sent from AdapTable to Excel
Accessing the API
Because OpenFin is available via a Plugin, the easiest way to access the Api is as follows:
const openFinApi = adaptableApi.pluginsApi.getOpenFinPluginApi();