FullscreenWizard Class

A base class for classes that implement fullscreen wizards.

Declaration

class FullscreenWizard extends Analytics.Wizard.PopupWizard

constructor(pageFactory)

Creates a new instance of the BaseWizard class.

Declaration

constructor(pageFactory: FullscreenWizardPageFactory, finishCallback?: any)

Parameters

Name Type Description
pageFactory FullscreenWizardPageFactory

The page factory.

finishCallback any

The finish callback.

Properties

navigationPanel Property

Specifies the navigation panel.

Declaration

navigationPanel: ko.Observable<WizardNavigationPanel>

Property Value

Type Description
Observable<WizardNavigationPanel>

The navigation panel.

pageFactory Property

Specifies the page factory.

Declaration

pageFactory: FullscreenWizardPageFactory

Property Value

Type Description
FullscreenWizardPageFactory

The page factory.

Remarks

The page factory stores metadata for all wizard pages by their IDs. A metadata object implements the IFullscreenWizardPageMetadata interface.

You can use the page factory to remove a specific page from the wizard or add a new page to the wizard.

Methods

onFinish Method

Completes the wizard and generates a report/data source based on the resulting global state.

Declaration

onFinish(): void

Remarks

You can use the beforeFinish and afterFinish events to customize the wizard result.

See the following topics for more information: