Skip to main content
All docs
V25.1
  • DevExpress v25.1 Update — Your Feedback Matters

    Our What's New in v25.1 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

    SpecifyJsonConnectionPage Class

    Implements the Choose JSON Data Connection section of the Report Wizard’s Specify Data Source Settings (JSON) page and the Data Source Wizard’s Specify Data Source Settings (JSON).

    #Declaration

    TypeScript
    export class SpecifyJsonConnectionPage extends ChooseJsonConnectionPage

    #Remarks

    This section allows users to choose a data connection or create a new connection for a JSON data source.

    This page section is available on the Specify Data Source Settings (JSON) page if there are predefined data connections. Otherwise, the ChooseJsonSourcePage section is available.

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

    See the following topics for more information:

    #constructor(connections, allowCreateNewJsonConnection)

    Initializes a new instance of the SpecifyJsonConnectionPage class with specified settings.

    #Declaration

    TypeScript
    constructor(
        connections: any,
        allowCreateNewJsonConnection: any,
        itemsProvider?: DevExpress.Analytics.Utils.IItemsProvider,
        _requestWrapper?: DevExpress.QueryBuilder.Utils.RequestWrapper,
        _getJsonConnectionsCallback?: () => JQueryPromise<DevExpress.Analytics.Wizard.IConnectionStringDefinition[]>
    )

    #Parameters

    Name Type
    connections any
    allowCreateNewJsonConnection any
    itemsProvider IItemsProvider
    _requestWrapper RequestWrapper
    _getJsonConnectionsCallback () => JQueryPromise<IConnectionStringDefinition[]>

    #Methods

    #canNext Method

    Specifies whether the next section is available.

    #Declaration

    TypeScript
    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

    TypeScript
    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

    TypeScript
    initialize(
        state: any
    ): JQuery.Promise<DevExpress.Analytics.Wizard.IWizardPage, any, any>

    #Parameters

    Name Type Description
    state any

    The section’s state.

    #Returns

    Type Description
    Promise<IWizardPage,any,any>

    A JQuery Promise object that identifies whether section initialization succeeded.