OpenFinApi
Provides run-time access to the OpenFin Plugin
TypeScript
export interfaceMethods
| 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 |
Method Details
getCurrentLiveOpenFinReport
Retrieves the OpenFin currently sending live data to Excel
TypeScript
getCurrentLiveOpenFinReport(): OpenFinReport | undefined;Returns
OpenFinReport | undefined
getOpenFinState
Retrieves the OpenFin section of System State
TypeScript
getOpenFinState(): OpenFinState | undefined;Returns
OpenFinState | undefined
getOpenFinThrottleTime
Retrieves the Throttle time for live updates
TypeScript
getOpenFinThrottleTime(): number | undefined;Returns
number | undefined
getPluginOptions
Retrieves the OpenFinPlugOptions provided in OpenFin Plugin
TypeScript
getPluginOptions(): OpenFinPluginOptions;Returns
isOpenFinAvailable
Whether OpenFin is available
TypeScript
isOpenFinAvailable(): boolean;Returns
boolean
isOpenFinRunning
Whether OpenFin is currently running
TypeScript
isOpenFinRunning(): boolean;Returns
boolean
showNotification
Shows a notification in OpenFin
TypeScript
showNotification(notification: any): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| notification | any |
Returns
void
showNotificationForAlert
Displays Alert as an OpenFin Notification
TypeScript
showNotificationForAlert(alert: AdaptableAlert): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| alert | AdaptableAlert | Alert to display |
Returns
void
startLiveData
Runs Report in Excel as Live Report (so updates as AdapTable ticks)
TypeScript
startLiveData(OpenFinReport: OpenFinReport): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| OpenFinReport | OpenFinReport | Report to Run |
Returns
void
stopLiveData
Stops live data; data will no longer be sent from AdapTable to Excel
TypeScript
stopLiveData(): void;Returns
void