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.
#Implements
#Inheritance
#constructor(dashboardControl)
Initializes a new instance of the DataSourceWizardExtension
class.
#Declaration
constructor(
dashboardControl: DevExpress.Dashboard.DashboardControl,
options?: DataSourceWizardExtensionOptions
)
#Parameters
Name | Type | Description |
---|---|---|
dashboard |
Dashboard |
A Web Dashboard control that owns the extension. |
options | Data |
A |
#Properties
#isCustomSqlEnabled Property
Specifies whether custom SQL strings editing is enabled.
#Declaration
get 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 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
off: DevExpress.Dashboard.Internal.EventSubscriber<DataSourceWizardExtensionEvents>
#Property Value
Type |
---|
Event |
#on Property
Subscribes to DataSourceWizardExtension events.
#Declaration
on: DevExpress.Dashboard.Internal.EventSubscriber<DataSourceWizardExtensionEvents>
#Property Value
Type |
---|
Event |
#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<DevExpress.Dashboard.Model.DataSource>
#Returns
Type | Description |
---|---|
JQuery |
A JQuery Promise object that identifies whether the action succeeded. |
#showFederationQueryEditingDialog(dashboardFederationDataSource, queryName) Method
#Declaration
showFederationQueryEditingDialog(
dashboardFederationDataSource: DevExpress.Dashboard.Model.FederationDataSource,
queryName: string
): void
#Parameters
Name | Type |
---|---|
dashboard |
Federation |
query |
string |
#showManageFederationQueriesDialog(dashboardFederationDataSource) Method
#Declaration
showManageFederationQueriesDialog(
dashboardFederationDataSource: DevExpress.Dashboard.Model.FederationDataSource
): void
#Parameters
Name | Type |
---|---|
dashboard |
Federation |
#showSqlQueryEditingDialog(dashboardSqlDataSource) Method
#Declaration
showSqlQueryEditingDialog(
dashboardSqlDataSource: DevExpress.Dashboard.Model.SqlDataSource,
queryName?: string
): void
#Parameters
Name | Type |
---|---|
dashboard |
Sql |
query |
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