ResultHighchart.ContextMenu (Pricefx Backend Server - Painkiller 18.0.0-SNAPSHOT API)

Enclosing class:: ResultHighchart

public static interface ResultHighchart.ContextMenu

The menu that opens when the user clicks a point in the chart. Get it from ResultHighchart.OnPointClick.showContextMenu().

When the clicked point has a drilldown, the menu shows a drilldown item first, followed by the items added with addMenuItem().

Since:: 14.0 - Caribou Lou

Method Summary

Modifier and Type

Method

Description

ResultHighchart.ContextMenuItem

addMenuItem()

Add a menu item to the ContextMenu.

ResultHighchart.OnPointClick

back()

Returns to the click definition of the chart.

default ResultHighchart.ContextMenu

setDrilldownLabel(String label)

Convenience method to customize the drilldown menu item's label without any translation options.

ResultHighchart.ContextMenu

setDrilldownLabelTranslations(Map<String,String> labelTranslations)

Customize the drilldown menu item's label in multiple languages so the UI will show the one appropriate for the current user.

Method Details
- setDrilldownLabel
  
  default ResultHighchart.ContextMenu setDrilldownLabel(String label)
  
  Convenience method to customize the drilldown menu item's label without any translation options.
  Note: the drilldown menu item will only show if a Highcharts API drilldown was defined in api.buildHighchart(properties)
  Parameters:
  
  label - the label of the menu item
  
  Returns:
  
  self - the ResultHighchart.ContextMenu instance, for convenience
  
  See Also:
  
  for setting language specific labels
- setDrilldownLabelTranslations
  
  ResultHighchart.ContextMenu setDrilldownLabelTranslations(Map<String,String> labelTranslations)
  
  Customize the drilldown menu item's label in multiple languages so the UI will show the one appropriate for the current user.
  Note: the drilldown menu item will only show if a Highcharts API drilldown was defined in api.buildHighchart(properties)
  
  Parameters:
  
  labelTranslations - the label of the menu item, referenced by language (e.g. "en", "de", or "" as default)
  
  Returns:
  
  self - the ResultHighchart.ContextMenu instance, for convenience
- addMenuItem
  
  ResultHighchart.ContextMenuItem addMenuItem()
  
  Add a menu item to the ContextMenu.
  
  Returns:
  
  a new ResultHighchart.ContextMenuItem
- back
  
  ResultHighchart.OnPointClick back()
  
  Returns to the click definition of the chart.
  
  Returns:
  
  the ResultHighchart.OnPointClick instance, for convenience