A Web Dashboard extension that is a dashboard item menu.
export class DashboardItemMenuExtension extends DisposableObjectInitializes a new instance of the DashboardItemMenuExtension class.
constructor(dashboardControl: DashboardControl)| Type | Name | Description |
|---|---|---|
| DashboardControl | dashboardControl | A Web Dashboard control that owns the extension. |
Specifies a unique extension name.
name: string| Type | Description |
|---|---|
| string | A unique extension name. The return value is 'item-menu'. |
Do not change a unique name of the extension registered in the Web Dashboard in order to avoid exceptions.
Clicks the specified menu item in the dashboard item menu.
menuItemClick(menuItemId: string): void| Type | Name | Description |
|---|---|---|
| string | menuItemId | A string value that is the menu item id. |
Allows you to process which key was pressed.
processKeyEvent(keyEventType: KeyEventType, eventArgs: JQueryKeyEventObject): boolean| Type | Name | Description |
|---|---|---|
| KeyEventType | keyEventType | The KeyEventType object that identifies a user interaction with the keyboard. |
| JQueryKeyEventObject | eventArgs | A JQueryKeyEventObject object that identifies a key. |
| Type | Description |
|---|---|
| boolean | true, if a key used to open the dashboard item menu; otherwise, false. |
Contains code that is executed when you register the dashboard extension.
start(): voidContains code that is executed when you unregister the dashboard extension.
stop(): void