The requested page is not available for the requested platform. You are viewing the content for Default platform.

DataSourceWizardExtension Class

A Web Dashboard extension that is the Data Source Wizard.

Declaration

export class DataSourceWizardExtension implements IExtension

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:

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));

See the Extension section for information on how to use the HTML JavaScript Dashboard's client-side API.

Implements

constructor(dashboardControl)

Initializes a new instance of the DataSourceWizardExtension class.

Declaration

constructor(dashboardControl: DashboardControl, options?: DataSourceWizardExtensionOptions)

Parameters

Name Type Description
dashboardControl DashboardControl

A Web Dashboard control that owns the extension.

Optional Parameters

Name Type Default Description
options DataSourceWizardExtensionOptions null

A DataSourceWizardExtension object that contains the extension options.

Properties

isCustomSqlEnabled Property

Specifies whether custom SQL strings editing is enabled.

Declaration

isCustomSqlEnabled: boolean

Property Value

Type Description
boolean

true, if custom SQL strings editing is enabled; otherwise, false.

name Property

Specifies a unique extension name.

Declaration

name: string

Property Value

Type Description
string

A unique extension name. The return value is 'data-source-wizard'.

Remarks

Warning

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

template Property

Declaration

template: string

Property Value

Type Description
string

Methods

showDataSourceCreatingDialog Method

Declaration

showDataSourceCreatingDialog(): JQueryPromise<any>

Returns

Type Description
JQueryPromise<any>

showSqlQueryEditingDialog(dashboardSqlDataSource) Method

Declaration

showSqlQueryEditingDialog(dashboardSqlDataSource: SqlDataSource, queryName?: string): void

Parameters

Name Type Description
dashboardSqlDataSource SqlDataSource

Optional Parameters

Name Type Default Description
queryName string null

start Method

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

Declaration

start(): void

stop Method

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

Declaration

stop(): void