Column Menu Technical Reference
Summary
- The Column Menu Options section of Adaptable Options a property used to define Column Menus
Column Menu Options
The Column Menu Options section is where Column Menus are configured in AdapTable and contains just 1 property:
| Property | Description |
|---|---|
| customColumnMenu | Customises Column Menu (default column menu items are available in the provided context) |
Column Menu API
The Column Menu API provides programmatic access to the Column Menu:
| Method | Description |
|---|---|
| createDefaultMenuStructure(context) | Creates default menu structure; useful as final line in custom implementation |
| createGroupMenu(label, subMenuItems, disabled, icon) | Creates a Group Menu Item |
| getColumnMenuItemByLabel(label, context) | Returns Menu Item with given label |
| getColumnMenuItemByName(menuItemName, context) | Returns the Menu Item with given name |
| getColumnMenuItemsByCategories(categories, context) | Gets all Menu Items in given categories |
| getColumnMenuItemsByCategory(category, context) | Gets all Menu Items in a given category |
| getColumnMenuItemsByLabels(labels, context) | Returns Menu Items with given labels |
| getColumnMenuItemsByNames(menuItemNames, context) | Returns the Menu Items with given names |
| hideColumnMenu(columnKey) | Hide the Column Menu |
| removeAdaptableColumnMenuItemByName(menuItemName, context) | Removes Menu Item with given name |
| removeAdaptableColumnMenuItemsByNames(menuItemNames, context) | Removes Menu Items with given names |
| showColumnMenu(columnKey) | Show the Column Menu |