Package net.pricefx.server.dto.calculation

Interface ResultHighchart.TriggerEvent

Enclosing class:

ResultHighchart

public static interface ResultHighchart.TriggerEvent

An event that the chart triggers when the user clicks a point. Get it from ResultHighchart.OnPointClick.triggerEvent(String).

Each with... method adds one attribute of the clicked point to the payload of the event.

Since:

3.7.1 - Bramble

Method Summary

Modifier and Type	Method	Description
ResultHighchart.OnPointClick	back()	Returns to the click definition of the chart.
default ResultHighchart.TriggerEvent	withCategoryAsEventDataAttr()	Short for withCustomEventDataAttr("category")
ResultHighchart.TriggerEvent	withCustomEventDataAttr(String customAttribute)	Pick one or more attributes of the Highchart data Point that should be included in the triggered event's payload.
default ResultHighchart.TriggerEvent	withNameAsEventDataAttr()	Short for withCustomEventDataAttr("name")
default ResultHighchart.TriggerEvent	withXAsEventDataAttr()	Short for withCustomEventDataAttr("x")
default ResultHighchart.TriggerEvent	withYAsEventDataAttr()	Short for withCustomEventDataAttr("y")

Method Details

withXAsEventDataAttr

default ResultHighchart.TriggerEvent withXAsEventDataAttr()

Short for withCustomEventDataAttr("x")

Returns:

the ResultHighchart.TriggerEvent instance, for convenience

withYAsEventDataAttr

default ResultHighchart.TriggerEvent withYAsEventDataAttr()

Short for withCustomEventDataAttr("y")

Returns:

the ResultHighchart.TriggerEvent instance, for convenience

withNameAsEventDataAttr

default ResultHighchart.TriggerEvent withNameAsEventDataAttr()

Short for withCustomEventDataAttr("name")

Returns:

the ResultHighchart.TriggerEvent instance, for convenience

withCategoryAsEventDataAttr

default ResultHighchart.TriggerEvent withCategoryAsEventDataAttr()

Short for withCustomEventDataAttr("category")

Returns:

the ResultHighchart.TriggerEvent instance, for convenience

withCustomEventDataAttr

ResultHighchart.TriggerEvent withCustomEventDataAttr(String customAttribute)

Pick one or more attributes of the Highchart data Point that should be included in the triggered event's payload. The attribute can then be mapped to a Dashboard Input Parameter (see ResultHighchart.onPointClick() for sample code).

Parameters:

customAttribute - the name of an attribute of the Highcharts point, for example "value"

Returns:

the ResultHighchart.TriggerEvent instance, for convenience

Throws:

IllegalArgumentException - if customAttribute is null or empty

back

ResultHighchart.OnPointClick back()

Returns to the click definition of the chart.

Returns:

the ResultHighchart.OnPointClick instance, for convenience