@adaptabletools/adaptable/src/Api/Events/LiveDataChanged.d.ts

Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements

import { Report } from '../../AdaptableState/ExportState';
import { BaseContext } from '../../types';
/**
 * EventInfo returned by LiveDataChanged event
 */
export interface LiveDataChangedInfo extends BaseContext {
    /**
     * Which Adaptable partner is the export destination for the live data
     */
    reportDestination: 'OpenFin' | 'ipushpull';
    /**
     * What triggered the event to fire
     */
    liveDataTrigger: 'Connected' | 'Disconnected' | 'SnapshotSent' | 'LiveDataStarted' | 'LiveDataStopped' | 'LiveDataUpdated';
    /**
     * The Report which is currently live - only used if the Trigger is LiveData related
     */
    liveReport?: any;
}
/**
 * Defines which Adaptable Reports are 'Live' (i.e. will update the destination as data in Adaptable ticks or changes)
 */
export interface LiveReport {
    /**
     * For OpenFin this is the workbook name; for iPushpull the page name
     */
    pageName: string;
    /**
     * The underlying Report
     */
    report: Report;
    /**
     * Where the live data is being sent
     */
    reportDestination: 'OpenfinExcel' | 'ipushpull';
}