ChooseJsonSchemaPage Class

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

Declaration

export class ChooseJsonSchemaPage extends WizardPageBase<DevExpress.Analytics.Wizard.IJsonDataSourceWizardState, DevExpress.Analytics.Wizard.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:

• Customize the Report/Data Source Wizard (ASP.NET Web Forms)
• Customize the Report/Data Source Wizard (ASP.NET MVC)
• Customize the Report/Data Source Wizard (ASP.NET Core)

Inherited Members

changeAlways

dispose

onChange(callback)

Inheritance

WizardPageBase<TState, TResult>

ChooseJsonSchemaPage

constructor

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

Declaration

constructor(
    _requestWrapper?: DevExpress.QueryBuilder.Utils.RequestWrapper,
    _allowObjectRootElements?: boolean,
    _callbacks?: DevExpress.Analytics.Wizard.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<DevExpress.Analytics.Wizard.IJsonDataSourceWizardState, any, any>

Returns

Type	Description
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: DevExpress.Analytics.Wizard.IJsonDataSourceWizardState
): JQueryPromise<DevExpress.Analytics.Data.JsonSchemaRootNode>

Parameters

Name	Type	Description
state	IJsonDataSourceWizardState	The section’s state.

Returns

Type	Description
JQueryPromise<JsonSchemaRootNode>	A JQuery Promise object that identifies whether the commit succeeded.

reset Method

Resets the section’s settings.

Declaration

reset(): void