Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

IDataSourceWizardState Interface

If implemented, provides functionality for the Data Source Wizard‘s global state.

#Declaration

TypeScript
export interface IDataSourceWizardState

#Remarks

The Data Source Wizard’s global state implements the IDataSourceWizardState interface and stores all the settings required to create a data source.

When the wizard runs, the initialize method initializes the global state with the predefined settings. The wizard’s onFinish method generates a data source based on the resulting global state.

Each wizard page uses a specific subset of the global state (a page’s local state). The page updates its local state based on a user’s input, and then, commits this state to the global state.

See the following topics for more information:

#Inheritance

IDataSourceWizardState

#Properties

#dataSourceId Property

Specifies the data source ID.

#Declaration

TypeScript
dataSourceId?: string

#Property Value

Type Description
string

The data source ID.

#dataSourceType Property

Specifies the data source type.

#Declaration

TypeScript
dataSourceType?: DevExpress.Analytics.Wizard.DataSourceType

#Property Value

Type Description
DataSourceType

The data source type.

#federationDataSourceWizard Property

#Declaration

TypeScript
federationDataSourceWizard?: DevExpress.Analytics.Wizard.IFederationDataSourceWizardState

#Property Value

Type
IFederationDataSourceWizardState

#jsonDataSourceWizard Property

Specifies the JSON data source settings.

#Declaration

TypeScript
jsonDataSourceWizard?: DevExpress.Analytics.Wizard.IJsonDataSourceWizardState

#Property Value

Type Description
IJsonDataSourceWizardState

The JSON data source settings.

#objectDataSourceWizard Property

Specifies the object data source settings.

#Declaration

TypeScript
objectDataSourceWizard?: DevExpress.Analytics.Wizard.IObjectDataSourceWizardState

#Property Value

Type Description
IObjectDataSourceWizardState

The object data source settings.

#predefinedDataSourceName Property

#Declaration

TypeScript
predefinedDataSourceName?: string

#Property Value

Type
string

#sqlDataSourceWizard Property

Specifies the SQL data source settings.

#Declaration

TypeScript
sqlDataSourceWizard?: DevExpress.Analytics.Wizard.ISqlDataSourceWizardState

#Property Value

Type Description
ISqlDataSourceWizardState

The SQL data source settings.