OpenFin Technical Reference
Summary
- The OpenFin Plugin provides extra functionality for users when AdapTable is running in the OpenFin container
OpenFin Plugin Options
Options for managing the OpenFin Plugin
| Property | Description | Default |
|---|---|---|
| notificationTimeout | Timeout (in ms) for OpenFin Notifications to expire; set false for notifications not to auto-dismiss | 5000 |
| onNotificationAction | Function which is invoked when a button in OpenFin notification is clicked | |
| onShowNotification | Updates OpenFin Notification object before it's displayed (just add/remove properties); return false to stop Notification showing | |
| onValidationFailureInExcel | Action to perform when a data change in Live Excel report triggers Prevent Edit Alert failure | |
| showAdaptableAlertsAsNotifications | Converts AdapTable Alerts configured to display in popup as OpenFin Notifications | true |
| showAppIconInNotifications | Icon to show in Notification - uses the value supplied in UserInterfaceOptions | true |
| throttleTime | How long (in ms) AdapTable throttles when sending data update to OpenFin | 2000 |
OpenFin API
The OpenFinAPI section of AdapTable contains many functions for run-time access to the OpenFin Plugin.
Caution
Some of these methods are intended for internal use only - and have been marked as such.
| Method | Description |
|---|---|
| getCurrentLiveOpenFinReport() | Retrieves the OpenFin currently sending live data to Excel |
| getOpenFinSchedules() | Retrieves all Schedules that send data to Excel via OpenFin |
| getOpenFinState() | Retrieves the OpenFin section of System State |
| getOpenFinThrottleTime() | Retrieves the Throttle time for live updates |
| getPluginOptions() | Retrieves the OpenFinPlugOptions provided in OpenFin Plugin |
| isOpenFinAvailable() | Whether OpenFin is available |
| isOpenFinRunning() | Whether OpenFin is currently running |
| showNotification(notification) | Shows a notification in OpenFin |
| showNotificationForAlert(alert) | Displays Alert as an OpenFin Notification |
| startLiveData(OpenFinReport) | Runs Report in Excel as Live Report (so updates as AdapTable ticks) |
| stopLiveData() | 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();