DefineReportLayoutPage<TState, TResult> Class

Implements the Report Wizard’s Define Report Layout page.

Declaration

class DefineReportLayoutPage extends Analytics.Wizard.FullscreenWizardPage

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 wizard page allows users to specify settings of a new JSON data source.

You can customize this page, hide specific sections or remove this page from the Report Wizard. To identify this page in code, use the FullscreenReportWizardPageId.DefineReportLayoutPage enumeration value.

See the following topics for more information:

• Customize the Report/Data Source Wizard (ASP.NET WebForms)
• Customize the Report/Data Source Wizard (ASP.NET MVC)
• Customize the Report/Data Source Wizard (ASP.NET Core)

Implements

IWizardPage

Inherited Members

events

canFinish

canNext

commit

dispose

initialize(state)

onChange(callback)

registerSection(sectionId, metadata)

setSectionPosition(sectionId)

unregisterSection(sectionId)

Inheritance

WizardPageBase<TState, TResult>

FullscreenWizardPage<TState, TResult>

DefineReportLayoutPage<TState, TResult>

constructor(_reportWizardOptions)

Creates a new instance of the DefineReportLayoutPage<TState, TResult> class with the specified settings.

Declaration

constructor(
    _reportWizardOptions: _ReportWizardOptions
)

Parameters

Name	Type	Description
_reportWizardOptions	_ReportWizardOptions	The page initialization settings.

Methods

getNextSectionId(sectionId) Method

Returns the next section’s ID.

Declaration

getNextSectionId(
    sectionId: string
): string

Parameters

Name	Type	Description
sectionId	string	The current section’s ID.

Returns

Type	Description
string	The next section’s ID.

Remarks

You should override this method when you remove a specific section from the page and want to skip this section in the navigation logic.

See the following topics for more information:

• Customize the Report/Data Source Wizard (ASP.NET WebForms)
• Customize the Report/Data Source Wizard (ASP.NET MVC)
• Customize the Report/Data Source Wizard (ASP.NET Core)

registerSections Method

Registers the page’s sections.

Declaration

registerSections(): void

Remarks

This method registers the following sections in the Define Report Layout page:

• SelectDataMembersPage - allows users to select queries and data fields to display in the report;
• AddGroupFieldsPage - allows users to add group fields;
• AddSummaryFieldsPage - allows users to add summary fields.