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 Extensions Overview section for information on how to use the HTML JavaScript Dashboard’s client-side API.
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 ‘url-state’. |
Remarks
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