AdaptableMenuItem

Generic Menu item used by Adaptable in Column or Context Menus

TypeScript
export interface AdaptableMenuItem<MENU_TYPE_NAME extends

Properties

PropertyDescription
categoryCategory of Adaptable Menu Item: Module, General, Group or CustomSettingsPanel
iconIcon to display in Menu Item
isVisibleWhether menu item is visible
labelText that appears in the menu
nameUnique name for the Menu Item
onClickFunction to invoke when (custom) menu item is clicked
subItemsSub Menu Items to display

Property Details

category

Category of Adaptable Menu Item: Module, General, Group or CustomSettingsPanel

TypeScript
category: MenuCategory;
Property Value

MenuCategory

icon

Icon to display in Menu Item

TypeScript
icon?: AdaptableIcon;
Property Value

AdaptableIcon

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[];
Property Value

AdaptableMenuItem[]