1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Slice Object
    4. Options Object
    5. Format Object
    6. Conditional Format Object
    7. Cell Data Object
  3. Methods
    1. All methods
    2. addCalculatedMeasure
    3. addCondition
    4. alert
    5. clear
    6. clearFilter
    7. clearXMLACache
    8. closeFieldsList
    9. collapseAllData
    10. collapseData
    11. connectTo
    12. customizeCell
    13. customizeContextMenu
    14. dispose
    15. expandAllData
    16. expandData
    17. exportTo
    18. getAllConditions
    19. getAllHierarchies
    20. getAllMeasures
    21. getCell
    22. getColumns
    23. getCondition
    24. getData
    25. getFilter
    26. getFilterProperties
    27. getFormat
    28. getMeasures
    29. getMembers
    30. getOptions
    31. getReport
    32. getReportFilters
    33. getRows
    34. getSelectedCell
    35. getSort
    36. getXMLACatalogs
    37. getXMLACubes
    38. getXMLADataSources
    39. getXMLAProviderName
    40. load
    41. off
    42. on
    43. open
    44. openFieldsList
    45. openFilter
    46. print
    47. refresh
    48. removeAllCalculatedMeasures
    49. removeAllConditions
    50. removeCalculatedMeasure
    51. removeCondition
    52. removeSelection
    53. runQuery
    54. save
    55. setBottomX
    56. setFilter
    57. setFormat
    58. setOptions
    59. setReport
    60. setSort
    61. setTopX
    62. showCharts
    63. showGrid
    64. showGridAndCharts
    65. sortingMethod
    66. sortValues
    67. updateData
  4. Events
    1. All events
    2. afterchartdraw
    3. aftergriddraw
    4. beforegriddraw
    5. beforetoolbarcreated
    6. cellclick
    7. celldoubleclick
    8. datachanged
    9. dataerror
    10. datafilecancelled
    11. dataloaded
    12. exportcomplete
    13. exportstart
    14. fieldslistclose
    15. fieldslistopen
    16. filterclose
    17. filteropen
    18. loadingdata
    19. loadinglocalization
    20. loadingolapstructure
    21. loadingreportfile
    22. localizationerror
    23. localizationloaded
    24. olapstructureerror
    25. olapstructureloaded
    26. openingreportfile
    27. printcomplete
    28. printstart
    29. querycomplete
    30. queryerror
    31. ready
    32. reportchange
    33. reportcomplete
    34. reportfilecancelled
    35. reportfileerror
    36. runningquery
    37. update
Table of contents

customizeContextMenu

customizeContextMenu(customizeFunction:Function)

[starting from version: 2.6]

This API call allows customizing context menu. For example, you can create context menu for a flat table or remove all context menu items for classic view.

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

Data passed to the customizeFunction:

  • items – Array of objects. Context menu items created by Flexmonster. Each object can have the following properties:
    • label – String. The name of the menu item.
    • handler – Function|String. The function or the name of the function that handles click on this item.
    • submenu (optional) – Array of objects. Array of submenu items. Each submenu item has the same structure as items.
    • isSelected (optional) – Boolean. Specifies whether the menu item is selected.
  • data – Object. Information about the right-clicked object. In case of right click on the grid, this is a Cell Data Object containing information about the cell. In case of right click on the chart element, this is a Chart Data Object containing information about the chart segment.
  • viewType – String. View type that was right-clicked. Can have one of the four possible values:
    1. "pivot" – Means that pivot grid was right-clicked, either compact or classic view.
    2. "flat" – Means that flat table view was right-clicked.
    3. "charts" – Means that charts view was right-clicked.
    4. "drillthrough" – Means that drill through view was right-clicked.

Returns

items, the array of new or changed context menu items. If items is null, the default items will be used. If items is [], context menu will be hidden.

Examples

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

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 context menus:

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