SpecifyJsonConnectionPage<TState, TResult> 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 SpecifyJsonConnectionPage extends ChooseJsonConnectionPage

Type Parameters

Name Description
TState

A type of the state to initialize the page (optional).

TResult

A type of the page's commit result (optional).

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:

Implements

constructor(connections, allowCreateNewJsonConnection)

Initializes a new instance of the SpecifyJsonConnectionPage<TState, TResult> class with specified settings.

Declaration

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

Parameters

Name Type
connections any
allowCreateNewJsonConnection any
itemsProvider IItemsProvider
_requestWrapper RequestWrapper

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<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: any): JQuery.Promise<IWizardPage, any, any>

Parameters

Name Type Description
state any

The section's state.

Returns

Type Description
JQuery.Promise<IWizardPage,any,any>

A JQuery Promise object that identifies whether section initialization succeeded.