UrlStateExtension Class
A Web Dashboard extension that displays a dashboard state in the url.
#Declaration
export class UrlStateExtension extends DisposableObject implements IExtension
#Remarks
Warning
This extension is in effect only on the ASP.
To configure the extension, refer to the UrlStateExtensionOptions class that contains options of the Url State extension.
See the following topic for information on how to use the DashboardControl’s client-side API: Extensions Overview.
#Implements
#Inheritance
#constructor(dashboardControl)
Initializes a new instance of the UrlStateExtension
class.
#Declaration
constructor(
dashboardControl: DevExpress.Dashboard.DashboardControl,
options?: UrlStateExtensionOptions
)
#Parameters
Name | Type | Description |
---|---|---|
dashboard |
Dashboard |
A Web Dashboard control that owns the extension. |
options | Url |
A Url |
#Properties
#name Property
Specifies the unique extension name.
#Declaration
name: string
#Property Value
Type | Description |
---|---|
string | The unique extension name. The return value is |
#Remarks
Use the urlState
name in the following cases:
- Call the DashboardControl.findExtension method and pass the extension name as a parameter to access the extension.
- Call the control’s option method to change the extension options.
Warning
Do not change the unique name of the extension registered in the Web Dashboard to avoid exceptions.
#Methods
#start Method
Contains code that is executed when you register the dashboard extension.
#Declaration
start(): void
#stop Method
Contains code that is executed when you unregister the dashboard extension.
#Declaration
stop(): void