Package net.pricefx.common.apibuilder.chart

Class ScatterChart.ScatterOnChartClick.ScatterTriggerEvent

Object

AbstractChartEvent<ScatterChart,ScatterChart.ScatterOnChartClick>.AbstractChartEvent.TriggerEvent<ScatterChart.ScatterOnChartClick.ScatterTriggerEvent>

ChartEvents.OnChartClick<ScatterChart,ScatterChart.ScatterOnChartClick>.ChartEvents.OnChartClick.ClickTriggerEvent<ScatterChart.ScatterOnChartClick.ScatterTriggerEvent>

ScatterTriggerEvent

Enclosing class:

ScatterChart.ScatterOnChartClick

public class ScatterChart.ScatterOnChartClick.ScatterTriggerEvent
extends ChartEvents.OnChartClick<ScatterChart,ScatterChart.ScatterOnChartClick>.ClickTriggerEvent<ScatterChart.ScatterOnChartClick.ScatterTriggerEvent>

The event-payload builder for a point click on a ScatterChart, obtained from ScatterChart.ScatterOnChartClick.triggerEvent(String) rather than instantiated directly.

Field Summary

Fields inherited from class AbstractChartEvent.TriggerEvent

eventName

Constructor Summary

Constructors

Constructor	Description
ScatterTriggerEvent(String eventName)

Method Summary

Modifier and Type	Method	Description
ScatterChart.ScatterOnChartClick.ScatterTriggerEvent	withAggregationByAsEventDataAttr()	Includes the clicked point's aggregation ("group by") dimension in the event payload, under the attribute name "aggregationBy".
ScatterChart.ScatterOnChartClick.ScatterTriggerEvent	withBandByAsEventDataAttr()	Includes the clicked point's "band by" dimension in the event payload, under the attribute name "bandBy".
ScatterChart.ScatterOnChartClick.ScatterTriggerEvent	withGroupByAsEventDataAttr()	Historical method name, prefer withAggregationByAsEventDataAttr().

Methods inherited from class ChartEvents.OnChartClick.ClickTriggerEvent

withXAsEventDataAttr

Methods inherited from class AbstractChartEvent.TriggerEvent

back, getThis

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScatterTriggerEvent

public ScatterTriggerEvent(String eventName)

Method Details

withAggregationByAsEventDataAttr

public ScatterChart.ScatterOnChartClick.ScatterTriggerEvent withAggregationByAsEventDataAttr()

Description copied from class: ChartEvents.OnChartClick.ClickTriggerEvent

Includes the clicked point's aggregation ("group by") dimension in the event payload, under the attribute name "aggregationBy".

Overrides:

withAggregationByAsEventDataAttr in class ChartEvents.OnChartClick<ScatterChart,ScatterChart.ScatterOnChartClick>.ClickTriggerEvent<ScatterChart.ScatterOnChartClick.ScatterTriggerEvent>

Returns:

this trigger-event builder, for chaining further configuration

See Also:

• ChartEvents.OnChartClick.ClickTriggerEvent.withBandByAsEventDataAttr()

withGroupByAsEventDataAttr

public ScatterChart.ScatterOnChartClick.ScatterTriggerEvent withGroupByAsEventDataAttr()

Historical method name, prefer withAggregationByAsEventDataAttr().

withBandByAsEventDataAttr

public ScatterChart.ScatterOnChartClick.ScatterTriggerEvent withBandByAsEventDataAttr()

Description copied from class: ChartEvents.OnChartClick.ClickTriggerEvent

Includes the clicked point's "band by" dimension in the event payload, under the attribute name "bandBy".

Overrides:

withBandByAsEventDataAttr in class ChartEvents.OnChartClick<ScatterChart,ScatterChart.ScatterOnChartClick>.ClickTriggerEvent<ScatterChart.ScatterOnChartClick.ScatterTriggerEvent>

Returns:

this trigger-event builder, for chaining further configuration

See Also:

• ChartEvents.OnChartClick.ClickTriggerEvent.withAggregationByAsEventDataAttr()