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

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:

• FullscreenReportWizardSectionId.SpecifyJsonConnectionPage for the Report Wizard;
• FullscreenDataSourceWizardSectionId.SpecifyJsonConnectionPage for the Data Source Wizard.

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

canCreateNew

changeAlways

items

selectedItems

canFinish

dispose

onChange(callback)

onDblClick

Inheritance

WizardPageBase<TState, TResult>

ChooseAvailableItemPage

ChooseJsonConnectionPage

SpecifyJsonConnectionPage

constructor(connections, allowCreateNewJsonConnection)

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

Declaration

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

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: 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.