Column Menu Technical Reference

Summary

The Column Menu Options section of Adaptable Options a property used to define Column Menus

The Column Menu Options section is where Column Menus are configured in AdapTable and contains just 1 property:

Property	Type	Description
customColumnMenu	`(menuContext:CustomColumnMenuContext<TData>) =>CustomColumnMenuItem[]`	Customises Column Menu (default column menu items are available in the provided context)

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

Method	Returns	Description
createDefaultMenuStructure(context)	`any`	Creates default menu structure; useful as final line in custom implementation
createGroupMenu(label, subMenuItems, disabled, icon)	`CustomGroupColumnMenuItem`	Creates a Group Menu Item
getColumnMenuItemByLabel(label, context)	`AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>`	Returns Menu Item with given label
getColumnMenuItemByName(menuItemName, context)	`AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>`	Returns the Menu Item with given name
getColumnMenuItemsByCategories(categories, context)	`AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[]`	Gets all Menu Items in given categories
getColumnMenuItemsByCategory(category, context)	`AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[]`	Gets all Menu Items in a given category
getColumnMenuItemsByLabels(labels, context)	`AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[]`	Returns Menu Items with given labels
getColumnMenuItemsByNames(menuItemNames, context)	`AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[]`	Returns the Menu Items with given names
hideColumnMenu()	`void`	Hide the Column Menu
removeAdaptableColumnMenuItemByName(menuItemName, context)	`any`	Removes Menu Item with given name
removeAdaptableColumnMenuItemsByNames(menuItemNames, context)	`any`	Removes Menu Items with given names
showColumnMenu(columnKey)	`void`	Show the Column Menu

PreviousDefault Menu Structure NextContext Menu