AdaptableMenuItem
Generic Menu item used by Adaptable in Column or Context Menus
TypeScript
export interface AdaptableMenuItem<MENU_TYPE_NAME extendsProperties
| Property | Type | Description |
|---|---|---|
| category | MenuCategory | Category of Adaptable Menu Item: Module, General, Group or CustomSettingsPanel |
| icon | AdaptableIcon | Icon to display in Menu Item |
| isVisible | boolean | Whether menu item is visible |
| label | string | Text that appears in the menu |
| name | MENU_TYPE_NAME | Unique name for the Menu Item |
| onClick | () => void | Function to invoke when (custom) menu item is clicked |
| subItems | AdaptableMenuItem[] | Sub Menu Items to display |
Property Details
category
Category of Adaptable Menu Item: Module, General, Group or CustomSettingsPanel
TypeScript
category: MenuCategory;Property Value
icon
Icon to display in Menu Item
TypeScript
icon?: AdaptableIcon;Property Value
isVisible
Whether menu item is visible
TypeScript
isVisible: boolean;Property Value
boolean
label
Text that appears in the menu
TypeScript
label: string;Property Value
string
name
Unique name for the Menu Item
TypeScript
name: MENU_TYPE_NAME;Property Value
MENU_TYPE_NAME
onClick
Function to invoke when (custom) menu item is clicked
TypeScript
onClick?: () => void;Property Value
() => void
subItems
Sub Menu Items to display
TypeScript
subItems?: AdaptableMenuItem[];