The requested page is not available for the requested platform. You are viewing the content for Default platform.

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 remove this item from the menu, call the unregisterExtension(extensionNames) method and pass the extension's unique name as a parameter:

dashboardControl.unregisterExtension('open-dashboard');

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 a unique extension name.

Declaration

name: string

Property Value

Type Description
string

A unique extension name. The return value is 'open-dashboard'.

Remarks

Warning

Do not change a unique name of the extension registered in the Web Dashboard in order 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.

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