Package net.pricefx.server.dto.calculation

Interface ResultHighchart.OnPointClick

Enclosing class:

ResultHighchart

public static interface ResultHighchart.OnPointClick

Defines what happens when the user clicks a point in the chart. Get it from ResultHighchart.onPointClick().

A click can either trigger events with triggerEvent(String) or open a context menu with showContextMenu(). One chart cannot use both.

Since:

3.7.1 - Bramble

Method Summary

Modifier and Type	Method	Description
ResultHighchart	back()	Returns to the chart.
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 showContextMenu() will throw an IllegalArgumentException.

Parameters:

eventName - the name of the event

Returns:

a new ResultHighchart.TriggerEvent instance

Throws:

IllegalArgumentException - if eventName is null or empty, or if showContextMenu() was already called for this chart

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 showContextMenu() will throw an IllegalArgumentException.

Example:

 import net.pricefx.formulaengine.scripting.AppPages

 return api.buildHighchart(definition)
         .onPointClick()
             .showContextMenu()
                 .addMenuItem()
                     .setLabel("Go to Customer Detail")
                     .setOrder(1)
                     .setContextLinking([
                             targetPage      : AppPages.DB_DASHBOARDS_PAGE,
                             id              : "CustomerDetail",
                             targetPageTarget: "new",
                             targetPageInputs: [Customer: "{point.options.customerId}"]
                     ])
                     .back()
                 .back()
             .back()
 

Returns:

a new ResultHighchart.ContextMenu instance

Throws:

IllegalArgumentException - if this method was already called for this chart, or if triggerEvent(String) was already called for it

Since:

14.0 - Caribou Lou

See Also:

• Custom Context Menu Items in Highcharts

back

ResultHighchart back()

Returns to the chart.

Returns:

the ResultHighchart instance, for convenience