DashboardItemMenuExtension Class
A Web Dashboard extension that is a dashboard item menu.
Declaration
export class DashboardItemMenuExtension extends DisposableObjectImplements
Inherited Members
Inheritance
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: stringProperty Value
| Type | Description |
|---|---|
| string | The unique extension name. The return value is 'item-menu'. |
Remarks
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): voidParameters
| 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): booleanParameters
| 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(): voidstop Method
Contains code that is executed when you unregister the dashboard extension.
Declaration
stop(): void