ChooseJsonSchemaPage Class

Implements the Select Data Fields section of the Data Source Wizard's Specify Data Source Settings (JSON) page.

Declaration

class ChooseJsonSchemaPage extends WizardPageBase<IJsonDataSourceWizardState, IJsonDataSourceWizardState>

Remarks

This section allows users to choose data fields to include in the resulting data source.

You can customize this section or remove it from the Specify Data Source Settings (JSON) page. To identify this section in code, use the FullscreenDataSourceWizardSectionId.ChooseJsonSchemaPage value.

See the following topics for more information:

Implements

Inherited Members

Inheritance

constructor

Creates a new instance of the ChooseJsonSchemaPage class with the default settings.

Declaration

constructor(_requestWrapper?: QueryBuilder.Utils.RequestWrapper, _allowObjectRootElements?: boolean, _callbacks?: Internal.IJsonDataSourceWizardCallbacks)

Parameters

Name Type
_requestWrapper RequestWrapper
_allowObjectRootElements boolean
_callbacks IJsonDataSourceWizardCallbacks

Methods

canFinish Method

Specifies whether it is possible to finish the wizard.

Declaration

canFinish(): boolean

Returns

Type Description
boolean

true, if it is possible to finish the wizard; otherwise, false.

canNext Method

Specifies whether the next section is available.

Declaration

canNext(): boolean

Returns

Type Description
boolean

true, if the next section is available; otherwise, false.

commit Method

Commits settings to the local page state.

Declaration

commit(): JQuery.Promise<IJsonDataSourceWizardState, any, any>

Returns

Type Description
JQuery.Promise<IJsonDataSourceWizardState,any,any>

A JQuery Promise object that identifies whether the commit succeeded.

initialize(state) Method

Initializes the section with the specified settings.

Declaration

initialize(state: IJsonDataSourceWizardState): JQuery.Promise<any, any, any>

Parameters

Name Type Description
state IJsonDataSourceWizardState

The section's state.

Returns

Type Description
JQuery.Promise<any,any,any>

A JQuery Promise object that identifies whether section initialization succeeded.

reset Method

Resets the section's settings.

Declaration

reset(): void