LiveDataChangedInfo
Payload of the LiveDataChanged event.
Fires for the ipushpull and OpenFin live-report plugins: when the destination connects or disconnects, a snapshot is sent, or live data starts, stops or is pushed.
Extends , so adaptableApi is included.
export interface LiveDataChangedInfo extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| liveDataTrigger | 'Connected' | 'Disconnected' | 'SnapshotSent' | 'LiveDataStarted' | 'LiveDataStopped' | 'LiveDataUpdated' | What happened: - Connected — the destination session started. liveReport is omitted.- Disconnected — the destination session ended. liveReport is omitted.- SnapshotSent — a one-off snapshot was sent. liveReport is omitted.- LiveDataStarted — a report started streaming. liveReport is that report.- LiveDataStopped — streaming stopped. liveReport is the report that was live.- LiveDataUpdated — a new snapshot of the live report was pushed. liveReport is that report. |
| liveReport | any | The ipushpull or OpenFin report this change is about. Set for LiveDataStarted, LiveDataStopped and LiveDataUpdated. Omitted for Connected, Disconnected and SnapshotSent.This is the plugin report (an ipushpull report or an OpenFin report), not a . |
| reportDestination | 'OpenFin' | 'ipushpull' | Destination this change belongs to: OpenFin or ipushpull. |
| adaptableContext | any | Custom application Context provided in AdaptableOptions.adaptableContext |
Property Details
liveDataTrigger
What happened:
Connected— the destination session started.liveReportis omitted.Disconnected— the destination session ended.liveReportis omitted.SnapshotSent— a one-off snapshot was sent.liveReportis omitted.LiveDataStarted— a report started streaming.liveReportis that report.LiveDataStopped— streaming stopped.liveReportis the report that was live.LiveDataUpdated— a new snapshot of the live report was pushed.liveReportis that report.
liveDataTrigger: 'Connected' | 'Disconnected' | 'SnapshotSent' | 'LiveDataStarted' | 'LiveDataStopped' | 'LiveDataUpdated';Property Value
'Connected' | 'Disconnected' | 'SnapshotSent' | 'LiveDataStarted' | 'LiveDataStopped' | 'LiveDataUpdated'
liveReport
The ipushpull or OpenFin report this change is about.
Set for LiveDataStarted, LiveDataStopped and LiveDataUpdated. Omitted for Connected, Disconnected and SnapshotSent.
This is the plugin report (an ipushpull report or an OpenFin report), not a .
liveReport?: any;Property Value
any
reportDestination
Destination this change belongs to: OpenFin or ipushpull.
reportDestination: 'OpenFin' | 'ipushpull';Property Value
'OpenFin' | 'ipushpull'
adaptableContext
Inherited from BaseContext
Custom application Context provided in AdaptableOptions.adaptableContext
adaptableContext: any;Property Value
any