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

DashboardItemMenuExtension Class

A Web Dashboard extension that is a dashboard item menu.

Declaration

export class DashboardItemMenuExtension extends DisposableObject

Inheritance

DisposableObject
DashboardItemMenuExtension

Implements

Inherited Members

constructor(dashboardControl)

Initializes a new instance of the DashboardItemMenuExtension 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 'item-menu'.

Remarks

Warning

Do not change a unique name of the extension registered in the Web Dashboard in order to avoid exceptions.

Methods

menuItemClick(menuItemId) Method

Clicks the specified menu item in the dashboard item menu.

menuItemClick(menuItemId: string): void
Name Type Description
menuItemId string

A string value that is the menu item id.

processKeyEvent(keyEventType, eventArgs) Method

Allows you to process which key was pressed.

Declaration

processKeyEvent(keyEventType: KeyEventType, eventArgs: JQueryKeyEventObject): boolean

Parameters

Name Type Description
keyEventType KeyEventType

The KeyEventType object that identifies a user interaction with the keyboard.

eventArgs JQueryKeyEventObject

A JQueryKeyEventObject object that identifies a key.

Returns

Type Description
boolean

true, if a key used to open the dashboard item menu; otherwise, false.

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