ChooseJsonSourcePage 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

class ChooseJsonSourcePage extends WizardPageBase<IJsonDataSourceWizardState, IJsonDataSourceWizardState>

Remarks

This section allows users to 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 no predefined data connections. Otherwise, the SpecifyJsonConnectionPage 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:

Implements

Inheritance

constructor

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

Declaration

constructor(_requestWrapper?: QueryBuilder.Utils.RequestWrapper, itemsProvider?: Analytics.Utils.IItemsProvider)

Parameters

Name Type
_requestWrapper RequestWrapper
itemsProvider IItemsProvider

Methods

canNext Method

Specifies whether the next section is available.

Declaration

canNext(): boolean

Returns

Type
boolean

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.