ChooseJsonSchemaPage Class

Implements the Select Data Fields section of the Report Wizard’s Specify Data Source Settings (JSON) page.

Declaration

export class ChooseJsonSchemaPage extends ChooseAnalyticJsonSchemaPage

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 FullscreenReportWizardSectionId.ChooseJsonSchemaPage value.

See the following topics for more information:

constructor(createJsonDataSourceInfo)

Creates a new instance of the ChooseJsonSchemaPage class with the specified settings.

Declaration

constructor(
    createJsonDataSourceInfo: (dataSource: JsonDataSource) => JQueryPromise<IDataSourceInfo>
)

Parameters

Name Type
createJsonDataSourceInfo (dataSource: JsonDataSource) => JQueryPromise<IDataSourceInfo>

Methods

commit Method

Commits settings to the local page state.

Declaration

commit(): JQuery.Promise<any, any, any>

Returns

Type Description
JQuery.Promise<any,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<any, any, any>

Parameters

Name Type Description
state any

The section’s state.

Returns

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

A JQuery Promise object that identifies whether section initialization succeeded.