IVisualizationCallbacks
Super-interface for all visualization callbacks.
export interface IVisualizationCallbacks
Remarks
All visualizations SHOULD have at least these callbacks defined.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Called when the visualization loads a DataView, i.e. it receives data from the backend. | |||
(Optional) Called when user triggers a drill on a visualization. | |||
(Optional) Called when an error occurs while loading data for the visualization. | |||
(Optional) Called when the visualization is ready to be exported. | |||
(Optional) Called when loading status of the visualization changes - vis starts or stops loading |
Property details
IVisualizationCallbacks.onDataViewpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Called when the visualization loads a DataView, i.e. it receives data from the backend.
onDataView?: OnDataView;
IVisualizationCallbacks.onDrillproperty
Called when user triggers a drill on a visualization.
onDrill?: OnFiredDrillEvent;
IVisualizationCallbacks.onErrorproperty
Called when an error occurs while loading data for the visualization.
onError?: OnError;
IVisualizationCallbacks.onExportReadyproperty
Called when the visualization is ready to be exported.
onExportReady?: OnExportReady;
IVisualizationCallbacks.onLoadingChangedproperty
Called when loading status of the visualization changes - vis starts or stops loading
onLoadingChanged?: OnLoadingChanged;