Skip to main content
All docs
V26.1
  • 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 ChooseJsonSchemaPageBase<DevExpress.Analytics.Data.JsonDataSource, 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:

    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

    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.