Package net.pricefx.server.dto.calculation

Interface ResultHighchart.OnPointClick

Enclosing class:

ResultHighchart

public static interface ResultHighchart.OnPointClick

Method Summary

Modifier and Type	Method	Description
ResultHighchart	back()
ResultHighchart.ContextMenu	showContextMenu()	Define a set of Context Linking options in a menu that will show when the user clicks in the chart.
ResultHighchart.TriggerEvent	triggerEvent(String eventName)	Define an event that will be triggered when the user clicks in the chart.

Method Details

triggerEvent

ResultHighchart.TriggerEvent triggerEvent(String eventName)

Define an event that will be triggered when the user clicks in the chart.
The name of the event is set as a parameter, the desired payload of the event can be set using instance methods of the returned ResultHighchart.TriggerEvent
Warning: this option is not compatible with showContextMenu(). Calling both triggerEvent() and showContext() menu will throw an IllegalArgumentException.

Parameters:

eventName - the name of the event

Returns:

a new ResultHighchart.TriggerEvent instance

showContextMenu

ResultHighchart.ContextMenu showContextMenu()

Define a set of Context Linking options in a menu that will show when the user clicks in the chart.
If a drilldown was defined, the first menu item will allow to trigger the drilldown. And the menu item's label can be customized with ResultHighchart.ContextMenu.setDrilldownLabel(String) and ResultHighchart.ContextMenu.setDrilldownLabelTranslations(Map)
Warning: this option is not compatible with triggerEvent(String). Calling both triggerEvent() and showContext() menu will throw an IllegalArgumentException.

Returns:

a new ResultHighchart.ContextMenu instance

back

ResultHighchart back()

Returns:

the ResultHighchart instance, for convenience