Skip to main content

DataSourceWizardExtension Class

A Web Dashboard extension that is the Data Source Wizard.

#Declaration

TypeScript
export class DataSourceWizardExtension implements ISupportOptionExtension<DataSourceWizardExtensionOptions>

#Remarks

Refer to the DataSourceWizardExtensionOptions class that contains the extension’s options to configure the extension.

The Web Dashboard supports two Data Source Wizard types:

DataSourceWizardExtension
A standard wizard.
MultiQueryDataSourceWizardExtension
A multi-query version.

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

JavaScript
dashboardControl.unregisterExtension('dataSourceWizard');
dashboardControl.registerExtension(new DevExpress.Dashboard.MultiQueryDataSourceWizardExtension(dashboardControl));

See the following topic for information on how to use the DashboardControl’s client-side API: Extensions Overview.

#Implements

ISupportOptionExtension

#Inheritance

DataSourceWizardExtension

#constructor(dashboardControl)

Initializes a new instance of the DataSourceWizardExtension class.

#Declaration

TypeScript
constructor(
    dashboardControl: DevExpress.Dashboard.DashboardControl,
    options?: DataSourceWizardExtensionOptions
)

#Parameters

Name Type Description
dashboardControl DashboardControl

A Web Dashboard control that owns the extension.

options DataSourceWizardExtensionOptions

A DataSourceWizardExtension object that contains the extension options.

#Properties

#isCustomSqlEnabled Property

Specifies whether custom SQL strings editing is enabled.

#Declaration

TypeScript
get isCustomSqlEnabled(): any

#Property Value

Type
any

#name Property

Specifies the unique extension name.

#Declaration

TypeScript
name: string

#Property Value

Type Description
string

The unique extension name. The return value is dataSourceWizard.

#Remarks

Use the dataSourceWizard name in the following cases:

  • Call the DashboardControl.findExtension method and pass the extension name as a parameter to access the extension.
  • Call the control’s option method to change the extension options.

Warning

Do not change the unique name of the extension registered in the Web Dashboard to avoid exceptions.

#off Property

Unsubscribes from the DataSourceWizardExtension’s events.

#Declaration

TypeScript
off: DevExpress.Dashboard.Internal.EventSubscriber<DataSourceWizardExtensionEvents>

#Property Value

Type
EventSubscriber<DataSourceWizardExtensionEvents>

#on Property

Subscribes to DataSourceWizardExtension events.

#Declaration

TypeScript
on: DevExpress.Dashboard.Internal.EventSubscriber<DataSourceWizardExtensionEvents>

#Property Value

Type
EventSubscriber<DataSourceWizardExtensionEvents>

#Remarks

The extension’s on and off methods help you subscribe to and unsubscribe from events.

#Methods

#showDataSourceCreatingDialog Method

Invokes the Data Source Creating dialog.

#Declaration

TypeScript
showDataSourceCreatingDialog(): JQueryPromise<DevExpress.Dashboard.Model.DataSource>

#Returns

Type Description
JQueryPromise<DataSource>

A JQuery Promise object that identifies whether the action succeeded.

#showFederationQueryEditingDialog(dashboardFederationDataSource, queryName) Method

#Declaration

TypeScript
showFederationQueryEditingDialog(
    dashboardFederationDataSource: DevExpress.Dashboard.Model.FederationDataSource,
    queryName: string
): void

#Parameters

Name Type
dashboardFederationDataSource FederationDataSource
queryName string

#showManageFederationQueriesDialog(dashboardFederationDataSource) Method

#Declaration

TypeScript
showManageFederationQueriesDialog(
    dashboardFederationDataSource: DevExpress.Dashboard.Model.FederationDataSource
): void

#Parameters

Name Type
dashboardFederationDataSource FederationDataSource

#showSqlQueryEditingDialog(dashboardSqlDataSource) Method

#Declaration

TypeScript
showSqlQueryEditingDialog(
    dashboardSqlDataSource: DevExpress.Dashboard.Model.SqlDataSource,
    queryName?: string
): void

#Parameters

Name Type
dashboardSqlDataSource SqlDataSource
queryName string

#start Method

Contains code that is executed when you register the dashboard extension.

#Declaration

TypeScript
start(): void

#stop Method

Contains code that is executed when you unregister the dashboard extension.

#Declaration

TypeScript
stop(): void