Skip to main content
A newer version of this page is available.
All docs
V19.1

SpecifyReportTitlePage<TState, TResult> Class

Implements the Specify Report Title section of the Report Wizard’s Specify Page Settings page.

Declaration

class SpecifyReportTitlePage extends Analytics.Wizard.WizardPageBase

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

You can customize this section or remove it from the Specify Page Settings page. To identify this section in code, use the FullscreenReportWizardSectionId.SpecifyReportTitlePage value.

See the following topics for more information:

Implements

Inheritance

WizardPageBase<TState, TResult>
SpecifyReportTitlePage<TState, TResult>

constructor

Creates a new instance of the SpecifyReportTitlePage<TState, TResult> class with the default settings.

Declaration

constructor()

Properties

reportTitle Property

Specifies the report title.

Declaration

reportTitle: ko.Observable<string> | ko.Computed<string>

Property Value

Type
Observable<string>
Computed<string>

Methods

commit Method

Commits settings to the local page state.

Declaration

commit(): JQueryPromise<{}>

Returns

Type Description
JQueryPromise<>

A JQuery Promise object that identifies whether the commit succeeded.

initialize(state) Method

Initializes the section with the specified settings.

Declaration

initialize(state: any): JQueryPromise<{}>

Parameters

Name Type Description
state any

The section’s state.

Returns

Type Description
JQueryPromise<>

A JQuery Promise object that identifies whether section initialization succeeded.