Skip to main content

PageIterator<T> Class

Defines the wizard’s page sequence.

Declaration

export class PageIterator<T = any> extends Disposable

Type Parameters

Name Description
T

The type.

Remarks

Use this class to change the page count and/or sequence. For instance, you can remove a specific wizard page or register a new page.

constructor<T>(pageFactory, stateManager)

Initializes a new instance of the PageIterator<T> class with specified settings.

Declaration

constructor(
    pageFactory: DevExpress.Analytics.Wizard.PageFactory,
    stateManager: DevExpress.Analytics.Wizard.StateManager,
    _onResetPage?: (page: DevExpress.Analytics.Wizard._WrappedWizardPage) => void
)

Parameters

Name Type Description
pageFactory PageFactory

The page factory.

stateManager StateManager

The state manager.

_onResetPage (page: _WrappedWizardPage) => void

Type Parameters

Name Description
T

The type.

Properties

pageFactory Property

Specifies the page factory.

Declaration

pageFactory: DevExpress.Analytics.Wizard.PageFactory

Property Value

Type Description
PageFactory

The page factory.

stateManager Property

Specifies the state manager.

Declaration

stateManager: DevExpress.Analytics.Wizard.StateManager

Property Value

Type Description
StateManager

The sate manager.

Methods

dispose Method

Disposes the page iterator.

Declaration

dispose(): void

getNextPageId Method

Returns the next page’s ID.

Declaration

getNextPageId(
    pageId?: string
): string

Parameters

Name Type Description
pageId string

The current page’s ID.

Returns

Type Description
string

The next page’s ID.

Remarks

Use this method to change the page count and/or sequence. For instance, you can remove a specific wizard page or register a new page.