MultiQueryDataSourceWizardExtension Class

A Web Dashboard extension that is the Multi Query Data Source Wizard.

Declaration

class MultiQueryDataSourceWizardExtension extends DataSourceWizardExtension

The Web Dashboard supports two Data Source Wizard types:

The Web Dashboard uses the DataSourceWizardExtension by default. The code snippet below shows how to enable the other wizard:

dashboardControl.unregisterExtension('data-source-wizard');
dashboardControl.registerExtension(new DevExpress.Dashboard.MultiQueryDataSourceWizardExtension(dashboardControl));

Inheritance

DataSourceWizardExtension
MultiQueryDataSourceWizardExtension

Implements

Constructors

Constructor

Initializes a new instance of the MultiQueryDataSourceWizardExtension class.

Declaration

constructor(_dashboardControl: DashboardControl, options?: DataSourceWizardExtensionOptions)

Parameters

Type Name Description
DashboardControl _dashboardControl

A Web Dashboard control that owns the extension.

DataSourceWizardExtensionOptions options

A DataSourceWizardExtensionOptions object that contains the extension options.

Properties

isCustomSqlEnabled Property

Declaration

isCustomSqlEnabled: boolean

Property Value

Type Description
boolean

name Property

Declaration

name: string

Property Value

Type Description
string

showDataSourceCreatingDialog Property

Declaration

showDataSourceCreatingDialog: (dataSourceContainer: KnockoutObservableArray<Model.DataSources.DataSource>) => void

Property Value

Type Description
(dataSourceContainer: KnockoutObservableArray<DataSource>) => void

showSqlQueryEditingDialog Property

Declaration

showSqlQueryEditingDialog: (dashboardSqlDataSource: Model.DataSources.SqlDataSource, queryName?: string) => void

Property Value

Type Description
(dashboardSqlDataSource: SqlDataSource, queryName?: string) => void

template Property

Declaration

template: string

Property Value

Type Description
string

Methods

start Method

Declaration

start(): void

stop Method

Declaration

stop(): void