UrlStateExtension Class
A Web Dashboard extension that displays a dashboard state in the url.
Declaration
export class UrlStateExtension extends DisposableObject implements IExtension
Remarks
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
Inherited Members
Inheritance
constructor(dashboardControl)
Initializes a new instance of the UrlStateExtension
class.
Declaration
constructor(
dashboardControl: DashboardControl,
options?: UrlStateExtensionOptions
)
Parameters
Name | Type | Description |
---|---|---|
dashboardControl | DashboardControl | A Web Dashboard control that owns the extension. |
options | UrlStateExtensionOptions | A UrlStateExtensionOptions object that contains the extension’s options. |
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 your applications so you can change the extension options when calling the control’s option method. Before v20.2 the extension name was url-state
. You can use the old name only in the DashboardControl.findExtension method.
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