PageFactory Class
Stores metadata for all wizard pages.
#Declaration
export class PageFactory
#Remarks
The page factory stores metadata for all wizard pages by their IDs. A metadata object implements the IWizardPageMetadata interface. The StateManager uses its getState and setState methods to manipulate with a local page state.
You can use the page factory’s unregisterMetadata method to remove a specific page from the wizard.
#Inheritance
#Properties
#metadata Property
Specifies the collection of metadata objects for wizard pages.
#Declaration
metadata: {
[key: string]: DevExpress.Analytics.Wizard.IWizardPageMetadata<IWizardPage>;
}
#Property Value
Type | Description |
---|---|
[key: string]: IWizard |
The collection of metadata objects. |
#Methods
#getMetadata(pageId) Method
Returns the specified page’s metadata.
#Declaration
getMetadata(
pageId: string
): DevExpress.Analytics.Wizard.IWizardPageMetadata<IWizardPage>
#Parameters
Name | Type |
---|---|
page |
string |
#Returns
Type | Description |
---|---|
IWizard |
The page metadata. |
#registerMetadata<T>(pageId, metadata) Method
Registers the specified page metadata.
#Declaration
registerMetadata<T extends DevExpress.Analytics.Wizard.IWizardPage>(
pageId: string,
metadata: DevExpress.Analytics.Wizard.IWizardPageMetadata<T>
): void
#Parameters
Name | Type | Description |
---|---|---|
page |
string | The page ID. |
metadata | IWizard |
The page metadata. |
#Type Parameters
Name | Type | Description |
---|---|---|
T | IWizard |
The page. |
#Remarks
Use this method to add a new page to the wizard.
#reset Method
Resets the collection of metadata objects.
#Declaration
reset(): void
#unregisterMetadata(pageId) Method
Removes metadata for the specified page.
#Declaration
unregisterMetadata(
pageId: string
): void
#Parameters
Name | Type | Description |
---|---|---|
page |
string | The page ID. |
#Remarks
Use this method to remove a specific page from the wizard.