DashboardItemMenuExtension Class

A Web Dashboard extension that is a dashboard item menu.

Declaration

export class DashboardItemMenuExtension extends DisposableObject

Remarks

To get access to the DashboardItemMenuExtension settings, call the control’s findExtension(extensionName) method and pass the extension’s name as a parameter.

var ext = dashboardControl.findExtension('item-menu');

Note

Use the itemMenu 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 item-menu. You can use the old name only in the DashboardControl.findExtension method.

Implements

IDisposable

Inherited Members

dispose

Inheritance

DisposableObject

DashboardItemMenuExtension

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

Declaration

name: string

Property Value

Type	Description
string	The unique extension name. The return value is itemMenu.

Remarks

Use the itemMenu 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 item-menu. 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

menuItemClick(menuItemId) Method

Clicks the specified menu item in the dashboard item menu.

Declaration

menuItemClick(
    menuItemId: string
): void

Parameters

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