DataSourceWizardExtensionOptions Interface
Provides options for customizing the DataSourceWizardExtension and MultiQueryDataSourceWizardExtension.
Declaration
export interface DataSourceWizardExtensionOptions
Remarks
See the following topic for information on how to use the DashboardControl’s client-side API: Extensions Overview.
Properties
allowCreateNewJsonConnection Property
Specifies whether an end user can create a JSON data source with a new data connection.
Declaration
allowCreateNewJsonConnection?: boolean
Property Value
Type | Description |
---|---|
boolean | true, to allow end users to create a JSON data source with a new data connection; otherwise, false. |
enableCustomSql Property
Enables a user to specify a custom SQL string in the Data Source wizard.
Declaration
enableCustomSql?: boolean
Property Value
Type | Description |
---|---|
boolean | true, to allow a user to specify a custom SQL string in the Data Source wizard; otherwise, false. |
Remarks
Executing custom SQL queries is forbidden by default. Use the AllowExecutingCustomSql property to allow the Web Dashboard to execute SQL queries on the server side.
Warning
The use of custom SQL queries can lead to inadvertent or unauthorized modifications to your data/database structure. Ensure that you follow best practices and implement the appropriate user read/write privileges at database level.
onCustomizeDataSourceWizard Property
A handler for the event that allows you to customize the Dashboard Data Source Wizard.
Declaration
onCustomizeDataSourceWizard?: (args: IDashboardWizardEventArgs) => void
Property Value
Type | Description |
---|---|
(args: IDashboardWizardEventArgs) => void | A function that is executed before the Dashboard Data Source Wizard is invoked. |
wizardSettings Property
Declaration
wizardSettings?: IDashboardDataSourceWizardSettings
Property Value
Type |
---|
IDashboardDataSourceWizardSettings |