OpenFin Technical Reference

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	Type	Description	Default
notificationTimeout	`number \| false`	Timeout (in ms) for OpenFin Notifications to expire; set false for notifications not to auto-dismiss	5000
onNotificationAction	`(event: \{ notification: any; type: string; trigger: string; result: \{ task: string; \}; \}) => any`	Function which is invoked when a button in OpenFin notification is clicked
onShowNotification	`(notification: any, alert?:AdaptableAlert) => any`	Updates OpenFin Notification object before it's displayed (just add/remove properties); return false to stop Notification showing
onValidationFailureInExcel	`'override' \| 'show-notification' \| 'show-undo-notification'`	Action to perform when a data change in Live Excel report triggers Prevent Edit Alert failure
showAdaptableAlertsAsNotifications	`boolean`	Converts AdapTable Alerts configured to display in popup as OpenFin Notifications	true
showAppIconInNotifications	`true`	Icon to show in Notification - uses the value supplied in UserInterfaceOptions	true
throttleTime	`number`	How long (in ms) AdapTable throttles when sending data update to OpenFin	2000

The OpenFinAPI section of AdapTable contains many functions for run-time access to the OpenFin Plugin.

Some of these methods are intended for internal use only - and have been marked as such.

Method	Returns	Description
getCurrentLiveOpenFinReport()	`OpenFinReport` `\| undefined`	Retrieves the OpenFin currently sending live data to Excel
getOpenFinState()	`OpenFinState` `\| undefined`	Retrieves the OpenFin section of System State
getOpenFinThrottleTime()	`number \| undefined`	Retrieves the Throttle time for live updates
getPluginOptions()	`OpenFinPluginOptions`	Retrieves the OpenFinPlugOptions provided in OpenFin Plugin
isOpenFinAvailable()	`boolean`	Whether OpenFin is available
isOpenFinRunning()	`boolean`	Whether OpenFin is currently running
showNotification(notification)	`void`	Shows a notification in OpenFin
showNotificationForAlert(alert)	`void`	Displays Alert as an OpenFin Notification
startLiveData(OpenFinReport)	`void`	Runs Report in Excel as Live Report (so updates as AdapTable ticks)
stopLiveData()	`void`	Stops live data; data will no longer be sent from AdapTable to Excel

Because OpenFin is available via a Plugin, the easiest way to access the Api is as follows:

const openFinApi = adaptableApi.pluginsApi.getOpenFinPluginApi();