DataSourceWizardExtension Class
A Web Dashboard extension that is the Data Source Wizard.
Declaration
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:
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
Inheritance
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. |
options | DataSourceWizardExtensionOptions | A |
Properties
isCustomSqlEnabled Property
Specifies whether custom SQL strings editing is enabled.
Declaration
readonly isCustomSqlEnabled: any
Property Value
Type |
---|
any |
name Property
Specifies the unique extension name.
Declaration
name: string
Property Value
Type | Description |
---|---|
string | The unique extension name. The return value is |
Remarks
Use the dataSourceWizard
name in your applications so you can change the extension options when calling the control’s option method. Before v20.2 the extension name was data-source-wizard
. You can use the old name only in the DashboardControl.findExtension method.
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
off: EventSubscriber<DataSourceWizardExtensionEvents>
Property Value
Type | Description |
---|---|
EventSubscriber<DataSourceWizardExtensionEvents> | An event subscription. |
on Property
Subscribes to the DataSourceWizardExtension’s events.
Declaration
on: EventSubscriber<DataSourceWizardExtensionEvents>
Property Value
Type | Description |
---|---|
EventSubscriber<DataSourceWizardExtensionEvents> | An event subscription. |
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
showDataSourceCreatingDialog(): JQueryPromise<DataSource>
Returns
Type | Description |
---|---|
JQueryPromise<DataSource> | A JQuery Promise object that identifies whether the action succeeded. |
showSqlQueryEditingDialog(dashboardSqlDataSource) Method
Declaration
showSqlQueryEditingDialog(
dashboardSqlDataSource: 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
start(): void
stop Method
Contains code that is executed when you unregister the dashboard extension.
Declaration
stop(): void