OpenDashboardExtension Class
A Web Dashboard extension that allows you to open the created dashboards.
Declaration
export class OpenDashboardExtension implements IExtension
Remarks
When registered, the OpenDashboardExtension
adds the “Open…” item to the dashboard menu.
To get access to the OpenDashboardExtension
settings, call the control’s findExtension(extensionName) method and pass the extension’s name as a parameter.
var ext = dashboardControl.findExtension('open-dashboard');
To remove this item from the menu, call the unregisterExtension(extensionNames) method and pass the extension’s unique name as a parameter:
dashboardControl.unregisterExtension('openDashboard');
Note
Use the openDashboard
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 open-dashboard
. You can use the old name only in the DashboardControl.findExtension method.
Implements
constructor(dashboardControl)
Initializes a new instance of the OpenDashboardExtension
class.
Declaration
constructor(
dashboardControl: DashboardControl
)
Parameters
Name | Type | Description |
---|---|---|
dashboardControl | DashboardControl | A Web Dashboard control that owns the extension. |
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 openDashboard
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 open-dashboard
. 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
loadDashboard(dashboardId) Method
Loads the dashboard from the dashboard storage.
Declaration
loadDashboard(
dashboardId: string
): JQueryPromise<any>
Parameters
Name | Type | Description |
---|---|---|
dashboardId | string | A string that is a dashboard unique identifier. |
Returns
Type | Description |
---|---|
JQueryPromise<any> | A JQuery Promise object that is resolved after the dashboard is loaded. |
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