Context Menu Technical Reference

Context Menu Options

The Context Menu Options section of Adaptable Options is where Context Menus are configured in AdapTable.

The section contains just 1, very flexible, property:

Property	Type	Description
customContextMenu	(menuContext:CustomContextMenuContext<TData>) =>CustomContextMenuItem[]	Customises Context Menu (default context menu items are available in provided context)

Context Menu API

The Context Menu API provides programmatic access to the Context Menu:

Method	Returns	Description
createDefaultMenuStructure(context)	any	Creates default menu structure; useful as final line in custom implementation
createGroupMenu(label, subMenuItems, disabled, icon)	CustomGroupContextMenuItem	Creates a Group Menu Item
getContextMenuItemByLabel(label, context)	AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>	Returns Menu Item with given label
getContextMenuItemByName(menuItemName, context)	AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>	Returns the Menu Item with given name
getContextMenuItemsByCategories(categories, context)	AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[]	Gets all Menu Items in given categories
getContextMenuItemsByCategory(category, context)	AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[]	Gets all Menu Items in a given category
getContextMenuItemsByLabels(labels, context)	AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[]	Returns Menu Items with given labels
getContextMenuItemsByNames(menuItemNames, context)	AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[]	Returns the Menu Items with given names
hideContextMenu()	void	Hide the Context Menu
removeAdaptableContextMenuItemByName(menuItemName, context)	any	Removes Menu Item with given name
removeAdaptableContextMenuItemsByNames(menuItemNames, context)	any	Removes Menu Items with given names