DashboardItemMenuExtension Class
A Web Dashboard extension that is a dashboard item menu.
#Declaration
export class DashboardItemMenuExtension extends DisposableObject
#Remarks
When registered, the DashboardItemMenuExtension
adds the dashboard item menu.
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('itemMenu');
To remove the extension, call the unregisterExtension(extensionNames) method and pass the extension’s unique name as a parameter:
dashboardControl.unregisterExtension('itemMenu');
You can also call the control’s option method to change the extension options.
#Inheritance
#constructor(dashboardControl)
Initializes a new instance of the DashboardItemMenuExtension
class.
#Declaration
constructor(
dashboardControl: DevExpress.Dashboard.DashboardControl
)
#Parameters
Name | Type | Description |
---|---|---|
dashboard |
Dashboard |
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 |
#Remarks
Use the itemMenu
name in the following cases:
- Call the DashboardControl.findExtension method and pass the extension name as a parameter to access the extension.
- Call the control’s option method to change the extension options.
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 |
---|---|---|
menu |
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: DevExpress.Dashboard.KeyEventType,
eventArgs: JQueryKeyEventObject
): boolean
#Parameters
Name | Type | Description |
---|---|---|
key |
Key |
The Key |
event |
JQuery |
A JQuery |
#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