Get Free Trial
API reference
Table of contents

customizeContextMenu

customizeContextMenu(customizeFunction: Function)

[starting from version: 2.6]

This API call allows customizing the context menu. For example, you can create a context menu for a flat table or remove all context menu items for the classic view. Learn more in this guide: Customizing the context menu.

customizeContextMenu can be defined in two ways:

  1. As a regular API call: flexmonster.customizeContextMenu(customizeFunction: Function).
  2. As an initialization parameter: new Flexmonster({customizeContextMenu: customizeFunction, ...}).

Parameters

  • customizeFunction – Function. It has the following signature: customizeFunction(items: Object[], data: CellDataObject | CellDataObject[] | ChartDataObject, viewType: String): Object[].
    Data passed to the customizeFunction:
    • items – Array of objects. Context menu items created by Flexmonster. Each object can have the following properties:
      • id – String. The ID of the menu item.
      • label – String. The name of the menu item.
      • handler – Function. The function that handles clicks on this item.
      • submenu optional – Array of objects. Contains submenu items. Each submenu item has the same structure as items.
      • isSelected optional – Boolean. Specifies whether the menu item is selected.
      • class optional – String. Adds a custom CSS class to the specified item.
    • dataCellDataObject | Array of CellDataObjects | ChartDataObject. Information about the right-clicked element.
      If a grid cell is right-clicked, the data is a CellDataObject containing information about the cell. If multiple cells are selected and then right-clicked, the data is an array of CellDataObjects.
      If a chart element is right-clicked, the data is a ChartDataObject containing information about the chart segment.
    • viewType – String. View type that was right-clicked. Can have one of the four possible values:
      • "pivot" – Means that the pivot grid was right-clicked, either compact or classic view.
      • "flat" – Means that the flat table view was right-clicked.
      • "charts" – Means that the chart view was right-clicked.
      • "drillthrough" – Means that drill through view was right-clicked.
    The customizeFunction must return items, the array of new or changed context menu items. If items is null, the default items will be used. If items is [], the context menu will be hidden.

Examples

1) Add a “Switch to charts” option to the flat table context menu:

flexmonster.customizeContextMenu(function(items, data, viewType) {
	if (viewType == "flat") 
		items.push({
			label: "Switch to charts",
			handler: function() {
				flexmonster.showCharts();
			}
		});
	return items;
});

Open the example on JSFiddle.

2) Remove “Aggregation” item from all the context menus:

flexmonster.customizeContextMenu(function(items, data, viewType) {
	items = items.filter(function (item){
				return item.label !== "Aggregation"
			})
	return items;
});

Open the example on JSFiddle.

See also

Customizing the context menu
customizeCell()
customizeChartElement()