All
  • Public
  • Public/Protected
  • All

Class RVDataSourceSelection

Object indicating what was selected by the end user, it could be a data source (like a database) or a data source item (like a table in a database). This selection object can also be used to indicate the UI to create a new data source should be displayed.

Hierarchy

  • RVDataSourceSelection

Index

Accessors

Methods

Accessors

dataSource

  • get dataSource(): null | RVDashboardDataSource

  • The selected data source or null if a data source item is selected.

    Returns null | RVDashboardDataSource

dataSourceItem

  • get dataSourceItem(): null | RVDataSourceItem

  • The selected data source item or null if a data source is selected.

    Returns null | RVDataSourceItem

newDataSourceProvider

  • The selected provider to create a new data source, if that was the option selected.

    Returns null | RVProviderType

onDataSourceCreated

  • get onDataSourceCreated(): null | function

  • Returns null | function

Methods

Static withDataSource

  • Creates a selection object for a data source.

    Parameters

    • ds: RVDashboardDataSource

      the selected data source.

    Returns RVDataSourceSelection

    A new selection object with a data source selected.

Static withDataSourceItem

  • Creates a selection object with a data source item.

    Parameters

    • dsItem: RVDataSourceItem

      the selected data source item.

    Returns RVDataSourceSelection

    A new selection object with a data source item selected.

Static withNewDataSource

  • Creates a selection object indicating the UI to create a new data source should be displayed, the data source will be created for the indicated provider (from RVProviderType, like SQLServer, REST, etc.)

    Parameters

    • provider: RVProviderType

      The data source provider to use to create the new data source (@see RVProviderType)

    • onDataSourceCreated: null | function = null

      An optional callback to be called when the creation of the new data source completes (it won't be called if the user cancels the creation flow).

    Returns RVDataSourceSelection

    A new selection object indicating a new data source should be created.