ContextMenuApi

Provides run-time access to Context Menu

TypeScript

export interface

Methods

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

Method Details

createDefaultMenuStructure

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

TypeScript

createDefaultMenuStructure(context: CustomContextMenuContext): any;

Parameters

Parameter	Type	Description
context	`CustomContextMenuContext`	Current Menu Context

Returns

any

createGroupMenu

Creates a Group Menu Item

TypeScript

createGroupMenu(label: string, subMenuItems: CustomContextMenuItem[], disabled?: boolean, icon?: AdaptableIcon): CustomGroupContextMenuItem;

Parameters

Parameter	Type	Description
label	`string`	Label for Group
subMenuItems	`CustomContextMenuItem[]`	Menu Items to place in Group
disabled	`boolean`	whether group is disabled
icon	`AdaptableIcon`	icon for the Group Menu Item

Returns

CustomGroupContextMenuItem

getContextMenuItemByLabel

Returns Menu Item with given label

TypeScript

getContextMenuItemByLabel(label: string, context: CustomContextMenuContext): AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>;

Parameters

Parameter	Type	Description
label	`string`	Label to filter on
context	`CustomContextMenuContext`	Current Menu Context

Returns

AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>

getContextMenuItemByName

Returns the Menu Item with given name

TypeScript

getContextMenuItemByName(menuItemName: AdaptableContextMenuItemName, context: CustomContextMenuContext): AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>;

Parameters

Parameter	Type	Description
menuItemName	`AdaptableContextMenuItemName`	Menu Item to filter on
context	`CustomContextMenuContext`	Current Menu Context

Returns

AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>

getContextMenuItemsByCategories

Gets all Menu Items in given categories

TypeScript

getContextMenuItemsByCategories(categories: MenuCategory[], context: CustomContextMenuContext): AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[];

Parameters

Parameter	Type	Description
categories	`MenuCategory[]`	Categories to filter on
context	`CustomContextMenuContext`	Current Menu Context

Returns

AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[]

getContextMenuItemsByCategory

Gets all Menu Items in a given category

TypeScript

getContextMenuItemsByCategory(category: MenuCategory, context: CustomContextMenuContext): AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[];

Parameters

Parameter	Type	Description
category	`MenuCategory`	Category to filter on
context	`CustomContextMenuContext`	Current Menu Context

Returns

AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[]

getContextMenuItemsByLabels

Returns Menu Items with given labels

TypeScript

getContextMenuItemsByLabels(labels: string[], context: CustomContextMenuContext): AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[];

Parameters

Parameter	Type	Description
labels	`string[]`	Labels to filter on
context	`CustomContextMenuContext`	Current Menu Context

Returns

AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[]

getContextMenuItemsByNames

Returns the Menu Items with given names

TypeScript

getContextMenuItemsByNames(menuItemNames: AdaptableContextMenuItemName[], context: CustomContextMenuContext): AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[];

Parameters

Parameter	Type	Description
menuItemNames	`AdaptableContextMenuItemName[]`	Menu Items to filter on
context	`CustomContextMenuContext`	Current Menu Context

Returns

AdaptableSystemContextMenuItem<AdaptableContextMenuItemName>[]

hideContextMenu

Hide the Context Menu

TypeScript

hideContextMenu(): void;

Returns

void

removeAdaptableContextMenuItemByName

Removes Menu Item with given name

TypeScript

removeAdaptableContextMenuItemByName(menuItemName: AdaptableContextMenuItemName, context: CustomContextMenuContext): any;

Parameters

Parameter	Type	Description
menuItemName	`AdaptableContextMenuItemName`	name of Menu Item to remove
context	`CustomContextMenuContext`	Current Menu Context

Returns

any

removeAdaptableContextMenuItemsByNames

Removes Menu Items with given names

TypeScript

removeAdaptableContextMenuItemsByNames(menuItemNames: AdaptableContextMenuItemName[], context: CustomContextMenuContext): any;

Parameters

Parameter	Type	Description
menuItemNames	`AdaptableContextMenuItemName[]`	names of Menu Items to remove
context	`CustomContextMenuContext`	Current Menu Context

Returns

any

PreviousContainerOptions NextContextMenuContext