IDataSourceWizardState Interface

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

Declaration

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

dataSourceId?: string

Property Value

Type Description
string

The data source ID.

dataSourceType Property

Specifies the data source type.

Declaration

dataSourceType?: DataSourceType

Property Value

Type Description
DataSourceType

The data source type.

jsonDataSourceWizard Property

Specifies the JSON data source settings.

Declaration

jsonDataSourceWizard?: IJsonDataSourceWizardState

Property Value

Type Description
IJsonDataSourceWizardState

The JSON data source settings.

objectDataSourceWizard Property

Specifies the object data source settings.

Declaration

objectDataSourceWizard?: IObjectDataSourceWizardState

Property Value

Type Description
IObjectDataSourceWizardState

The object data source settings.

sqlDataSourceWizard Property

Specifies the SQL data source settings.

Declaration

sqlDataSourceWizard?: ISqlDataSourceWizardState

Property Value

Type Description
ISqlDataSourceWizardState

The SQL data source settings.