# ContextMenuApi

Canonical page: https://www.adaptabletools.com/docs/reference/contextmenuapi

The right-click menu: the default items, and adding or removing items.

```ts title="TypeScript"
export interface ContextMenuApi 
```

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [createDefaultMenuStructure(context)](https://www.adaptabletools.com/docs/reference/contextmenuapi.md#createdefaultmenustructure) | `any` | Creates default menu structure; useful as final line in custom implementation |
| [createGroupMenu(label, subMenuItems, disabled, icon)](https://www.adaptabletools.com/docs/reference/contextmenuapi.md#creategroupmenu) | [`CustomGroupContextMenuItem`](https://www.adaptabletools.com/docs/reference/customgroupcontextmenuitem.md) | Creates a Group Menu Item |
| [getContextMenuItemByLabel(label, context)](https://www.adaptabletools.com/docs/reference/contextmenuapi.md#getcontextmenuitembylabel) | [`AdaptableSystemContextMenuItem`](https://www.adaptabletools.com/docs/reference/adaptablesystemcontextmenuitem.md)`<`[`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md)`>` | Returns Menu Item with given label |
| [getContextMenuItemByName(menuItemName, context)](https://www.adaptabletools.com/docs/reference/contextmenuapi.md#getcontextmenuitembyname) | [`AdaptableSystemContextMenuItem`](https://www.adaptabletools.com/docs/reference/adaptablesystemcontextmenuitem.md)`<`[`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md)`>` | Returns the Menu Item with given name |
| [getContextMenuItemsByCategories(categories, context)](https://www.adaptabletools.com/docs/reference/contextmenuapi.md#getcontextmenuitemsbycategories) | [`AdaptableSystemContextMenuItem`](https://www.adaptabletools.com/docs/reference/adaptablesystemcontextmenuitem.md)`<`[`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md)`>[]` | Gets all Menu Items in given categories |
| [getContextMenuItemsByCategory(category, context)](https://www.adaptabletools.com/docs/reference/contextmenuapi.md#getcontextmenuitemsbycategory) | [`AdaptableSystemContextMenuItem`](https://www.adaptabletools.com/docs/reference/adaptablesystemcontextmenuitem.md)`<`[`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md)`>[]` | Gets all Menu Items in a given category |
| [getContextMenuItemsByLabels(labels, context)](https://www.adaptabletools.com/docs/reference/contextmenuapi.md#getcontextmenuitemsbylabels) | [`AdaptableSystemContextMenuItem`](https://www.adaptabletools.com/docs/reference/adaptablesystemcontextmenuitem.md)`<`[`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md)`>[]` | Returns Menu Items with given labels |
| [getContextMenuItemsByNames(menuItemNames, context)](https://www.adaptabletools.com/docs/reference/contextmenuapi.md#getcontextmenuitemsbynames) | [`AdaptableSystemContextMenuItem`](https://www.adaptabletools.com/docs/reference/adaptablesystemcontextmenuitem.md)`<`[`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md)`>[]` | Returns the Menu Items with given names |
| [hideContextMenu()](https://www.adaptabletools.com/docs/reference/contextmenuapi.md#hidecontextmenu) | `void` | Hide the Context Menu |
| [removeAdaptableContextMenuItemByName(menuItemName, context)](https://www.adaptabletools.com/docs/reference/contextmenuapi.md#removeadaptablecontextmenuitembyname) | `any` | Removes Menu Item with given name |
| [removeAdaptableContextMenuItemsByNames(menuItemNames, context)](https://www.adaptabletools.com/docs/reference/contextmenuapi.md#removeadaptablecontextmenuitemsbynames) | `any` | Removes Menu Items with given names |

## Method Details

### createDefaultMenuStructure

Creates default menu structure; useful as final line in custom implementation

```ts title="TypeScript"
createDefaultMenuStructure(context: CustomContextMenuContext): any;
```

###### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| context | [`CustomContextMenuContext`](https://www.adaptabletools.com/docs/reference/customcontextmenucontext.md) | Current Menu Context |

###### Returns

 The default menu: the AG Grid items, a separator, then the AdapTable items

`any`

### createGroupMenu

Creates a Group Menu Item

```ts title="TypeScript"
createGroupMenu(label: string, subMenuItems: CustomContextMenuItem[], disabled?: boolean, icon?: AdaptableIcon): CustomGroupContextMenuItem;
```

###### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| label | `string` | Label for Group |
| subMenuItems | [`CustomContextMenuItem`](https://www.adaptabletools.com/docs/reference/customcontextmenuitem.md)`[]` | Menu Items to place in Group |
| disabled | `boolean` | whether group is disabled |
| icon | [`AdaptableIcon`](https://www.adaptabletools.com/docs/reference/adaptableicon.md) | icon for the Group Menu Item |

###### Returns

 The group menu item

[`CustomGroupContextMenuItem`](https://www.adaptabletools.com/docs/reference/customgroupcontextmenuitem.md)

### getContextMenuItemByLabel

Returns Menu Item with given label

```ts title="TypeScript"
getContextMenuItemByLabel(label: string, context: CustomContextMenuContext): AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>;
```

###### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| label | `string` | Label to filter on |
| context | [`CustomContextMenuContext`](https://www.adaptabletools.com/docs/reference/customcontextmenucontext.md) | Current Menu Context |

###### Returns

 Menu Item with given label

[`AdaptableSystemContextMenuItem`](https://www.adaptabletools.com/docs/reference/adaptablesystemcontextmenuitem.md)`<`[`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md)`>`

### getContextMenuItemByName

Returns the Menu Item with given name

```ts title="TypeScript"
getContextMenuItemByName(menuItemName: AdaptableContextMenuItemName, context: CustomContextMenuContext): AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>;
```

###### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| menuItemName | [`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md) | Menu Item to filter on |
| context | [`CustomContextMenuContext`](https://www.adaptabletools.com/docs/reference/customcontextmenucontext.md) | Current Menu Context |

###### Returns

 The Menu Item with given name

[`AdaptableSystemContextMenuItem`](https://www.adaptabletools.com/docs/reference/adaptablesystemcontextmenuitem.md)`<`[`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md)`>`

### getContextMenuItemsByCategories

Gets all Menu Items in given categories

```ts title="TypeScript"
getContextMenuItemsByCategories(categories: MenuCategory[], context: CustomContextMenuContext): AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[];
```

###### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| categories | [`MenuCategory`](https://www.adaptabletools.com/docs/reference/menucategory.md)`[]` | Categories to filter on |
| context | [`CustomContextMenuContext`](https://www.adaptabletools.com/docs/reference/customcontextmenucontext.md) | Current Menu Context |

###### Returns

 All Menu Items in given categories

[`AdaptableSystemContextMenuItem`](https://www.adaptabletools.com/docs/reference/adaptablesystemcontextmenuitem.md)`<`[`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md)`>[]`

### getContextMenuItemsByCategory

Gets all Menu Items in a given category

```ts title="TypeScript"
getContextMenuItemsByCategory(category: MenuCategory, context: CustomContextMenuContext): AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[];
```

###### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| category | [`MenuCategory`](https://www.adaptabletools.com/docs/reference/menucategory.md) | Category to filter on |
| context | [`CustomContextMenuContext`](https://www.adaptabletools.com/docs/reference/customcontextmenucontext.md) | Current Menu Context |

###### Returns

 All Menu Items in a given category

[`AdaptableSystemContextMenuItem`](https://www.adaptabletools.com/docs/reference/adaptablesystemcontextmenuitem.md)`<`[`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md)`>[]`

### getContextMenuItemsByLabels

Returns Menu Items with given labels

```ts title="TypeScript"
getContextMenuItemsByLabels(labels: string[], context: CustomContextMenuContext): AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[];
```

###### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| labels | `string[]` | Labels to filter on |
| context | [`CustomContextMenuContext`](https://www.adaptabletools.com/docs/reference/customcontextmenucontext.md) | Current Menu Context |

###### Returns

 Menu Items with given labels

[`AdaptableSystemContextMenuItem`](https://www.adaptabletools.com/docs/reference/adaptablesystemcontextmenuitem.md)`<`[`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md)`>[]`

### getContextMenuItemsByNames

Returns the Menu Items with given names

```ts title="TypeScript"
getContextMenuItemsByNames(menuItemNames: AdaptableContextMenuItemName[], context: CustomContextMenuContext): AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[];
```

###### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| menuItemNames | [`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md)`[]` | Menu Items to filter on |
| context | [`CustomContextMenuContext`](https://www.adaptabletools.com/docs/reference/customcontextmenucontext.md) | Current Menu Context |

###### Returns

 The Menu Items with given names

[`AdaptableSystemContextMenuItem`](https://www.adaptabletools.com/docs/reference/adaptablesystemcontextmenuitem.md)`<`[`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md)`>[]`

### hideContextMenu

Hide the Context Menu

```ts title="TypeScript"
hideContextMenu(): void;
```

###### Returns

`void`

### removeAdaptableContextMenuItemByName

Removes Menu Item with given name

```ts title="TypeScript"
removeAdaptableContextMenuItemByName(menuItemName: AdaptableContextMenuItemName, context: CustomContextMenuContext): any;
```

###### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| menuItemName | [`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md) | name of Menu Item to remove |
| context | [`CustomContextMenuContext`](https://www.adaptabletools.com/docs/reference/customcontextmenucontext.md) | Current Menu Context |

###### Returns

 The menu items that remain

`any`

### removeAdaptableContextMenuItemsByNames

Removes Menu Items with given names

```ts title="TypeScript"
removeAdaptableContextMenuItemsByNames(menuItemNames: AdaptableContextMenuItemName[], context: CustomContextMenuContext): any;
```

###### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| menuItemNames | [`AdaptableContextMenuItemName`](https://www.adaptabletools.com/docs/reference/adaptablecontextmenuitemname.md)`[]` | names of Menu Items to remove |
| context | [`CustomContextMenuContext`](https://www.adaptabletools.com/docs/reference/customcontextmenucontext.md) | Current Menu Context |

###### Returns

 The menu items that remain

`any`
