search

Preparing search index...
The search index is not available

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.

Hierarchy

DataSourceSelectionEventArgs

Index

Constructors

constructor

Properties

cancel

Accessors

Constructors

constructor

new DataSourceSelectionEventArgs(callback: function, dataSources: any, trigger: RVDataSourcesRequestedTriggerType): DataSourceSelectionEventArgs

Parameters
- callback: function
  - - (selection: RVDataSourceSelection): void
    - Parameters
      - selection: RVDataSourceSelection
      Returns 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(): function

The callback to use when the selection is ready. Receives a RVDataSourceSelection object created using the helper methods RVDataSourceSelection.withDataSource or RVDataSourceSelection.withDataSourceItem.

Returns function
- - (selection: RVDataSourceSelection): void
  - Parameters
    - selection: RVDataSourceSelection
    Returns 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