ColumnMenuApi
Provides run-time access to Column Menu
TypeScript
export interfaceMethods
| 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 |
Method Details
createDefaultMenuStructure
Creates default menu structure; useful as final line in custom implementation
TypeScript
createDefaultMenuStructure(context: CustomColumnMenuContext): any;Parameters
| Parameter | Type | Description |
|---|---|---|
| context | CustomColumnMenuContext | Current Menu Context |
Returns
any
createGroupMenu
Creates a Group Menu Item
TypeScript
createGroupMenu(label: string, subMenuItems: CustomColumnMenuItem[], disabled?: boolean, icon?: AdaptableIcon): CustomGroupColumnMenuItem;Parameters
| Parameter | Type | Description |
|---|---|---|
| label | string | Label for Group |
| subMenuItems | CustomColumnMenuItem[] | Menu Items to place in Group |
| disabled | boolean | whether group is disabled |
| icon | AdaptableIcon | icon for the Group Menu Item |
Returns
getColumnMenuItemByLabel
Returns Menu Item with given label
TypeScript
getColumnMenuItemByLabel(label: string, context: CustomColumnMenuContext): AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>;Parameters
| Parameter | Type | Description |
|---|---|---|
| label | string | Label to filter on |
| context | CustomColumnMenuContext | Current Menu Context |
Returns
AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>
getColumnMenuItemByName
Returns the Menu Item with given name
TypeScript
getColumnMenuItemByName(menuItemName: AdaptableColumnMenuItemName, context: CustomColumnMenuContext): AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>;Parameters
| Parameter | Type | Description |
|---|---|---|
| menuItemName | AdaptableColumnMenuItemName | Menu Item to filter on |
| context | CustomColumnMenuContext | Current Menu Context |
Returns
AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>
getColumnMenuItemsByCategories
Gets all Menu Items in given categories
TypeScript
getColumnMenuItemsByCategories(categories: MenuCategory[], context: CustomColumnMenuContext): AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[];Parameters
| Parameter | Type | Description |
|---|---|---|
| categories | MenuCategory[] | Categories to filter on |
| context | CustomColumnMenuContext | Current Menu Context |
Returns
AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[]
getColumnMenuItemsByCategory
Gets all Menu Items in a given category
TypeScript
getColumnMenuItemsByCategory(category: MenuCategory, context: CustomColumnMenuContext): AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[];Parameters
| Parameter | Type | Description |
|---|---|---|
| category | MenuCategory | Category to filter on |
| context | CustomColumnMenuContext | Current Menu Context |
Returns
AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[]
getColumnMenuItemsByLabels
Returns Menu Items with given labels
TypeScript
getColumnMenuItemsByLabels(labels: string[], context: CustomColumnMenuContext): AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[];Parameters
| Parameter | Type | Description |
|---|---|---|
| labels | string[] | Labels to filter on |
| context | CustomColumnMenuContext | Current Menu Context |
Returns
AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[]
getColumnMenuItemsByNames
Returns the Menu Items with given names
TypeScript
getColumnMenuItemsByNames(menuItemNames: AdaptableColumnMenuItemName[], context: CustomColumnMenuContext): AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[];Parameters
| Parameter | Type | Description |
|---|---|---|
| menuItemNames | AdaptableColumnMenuItemName[] | Menu Items to filter on |
| context | CustomColumnMenuContext | Current Menu Context |
Returns
AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[]
hideColumnMenu
Hide the Column Menu
TypeScript
hideColumnMenu(columnKey: string): void;Parameters
| Parameter | Type |
|---|---|
| columnKey | string |
Returns
void
removeAdaptableColumnMenuItemByName
Removes Menu Item with given name
TypeScript
removeAdaptableColumnMenuItemByName(menuItemName: AdaptableColumnMenuItemName, context: CustomColumnMenuContext): any;Parameters
| Parameter | Type | Description |
|---|---|---|
| menuItemName | AdaptableColumnMenuItemName | name of Menu Item to remove |
| context | CustomColumnMenuContext | Current Menu Context |
Returns
any
removeAdaptableColumnMenuItemsByNames
Removes Menu Items with given names
TypeScript
removeAdaptableColumnMenuItemsByNames(menuItemNames: AdaptableColumnMenuItemName[], context: CustomColumnMenuContext): any;Parameters
| Parameter | Type | Description |
|---|---|---|
| menuItemNames | AdaptableColumnMenuItemName[] | names of Menu Items to remove |
| context | CustomColumnMenuContext | Current Menu Context |
Returns
any
showColumnMenu
Show the Column Menu
TypeScript
showColumnMenu(columnKey: string): void;Parameters
| Parameter | Type |
|---|---|
| columnKey | string |
Returns
void