Class DataSourceSelectionEventArgs

The class used as the argument to the onDataSourceSelection event with the trigger and list of data sources in use in the dashboard.

Index

Constructors

constructor

Properties

cancel

Accessors

callback
dataSources
trigger

Constructors

constructor

new DataSourceSelectionEventArgs(
    callback: (selection: RVDataSourceSelection) => void,
    dataSources: any,
    trigger: RVDataSourcesRequestedTriggerType,
): DataSourceSelectionEventArgs
Parameters
- callback: (selection: RVDataSourceSelection) => void
- dataSources: any
- trigger: RVDataSourcesRequestedTriggerType
Returns DataSourceSelectionEventArgs

Properties

cancel

cancel: boolean

Set this to true to cancel the display of the standard UI for selecting data sources

Accessors

callback

get callback(): (selection: RVDataSourceSelection) => void
The callback to use when the selection is ready. Receives a RVDataSourceSelection object created using the helper methods RVDataSourceSelection.withDataSource or RVDataSourceSelection.withDataSourceItem.

Returns (selection: RVDataSourceSelection) => void

dataSources

get dataSources(): any
List of data sources returned by onDataSourcesRequested.

Returns any

trigger

get trigger(): RVDataSourcesRequestedTriggerType
Event that originated the data sources selection, one of visualization, dashboard filter or data blending.

Returns RVDataSourcesRequestedTriggerType