Package net.pricefx.common.apibuilder.chart

Class ChartEvents.OnChartClick.ClickTriggerEvent<T extends ChartEvents.OnChartClick<C,E>.ClickTriggerEvent<?>>

Object

AbstractChartEvent<C,E>.AbstractChartEvent.TriggerEvent<T>

ClickTriggerEvent<T>

Direct Known Subclasses:

BarLineChart.BarLineOnChartClick.BarLineTriggerEvent, BubbleChart.BubbleOnChartClick.BubbleTriggerEvent, ScatterChart.ScatterOnChartClick.ScatterTriggerEvent

Enclosing class:

ChartEvents.OnChartClick<C extends AbstractChartBuilder<?>,E extends ChartEvents.OnChartClick<C,E>>

public abstract class ChartEvents.OnChartClick.ClickTriggerEvent<T extends ChartEvents.OnChartClick<C,E>.ClickTriggerEvent<?>>
extends AbstractChartEvent<C,E>.TriggerEvent<T>

Base class for the event-payload builder returned by a chart-type-specific AbstractChartEvent.triggerEvent(String), for example ScatterChart.ScatterOnChartClick.ScatterTriggerEvent or BarLineChart.BarLineOnChartClick.BarLineTriggerEvent. You never instantiate this class or a concrete subclass of it directly. Which of this class's methods a concrete chart type exposes depends on what data that chart type's clicked point can provide.

Field Summary

Fields inherited from class AbstractChartEvent.TriggerEvent

eventName

Constructor Summary

Constructors

Constructor	Description
ClickTriggerEvent(String eventName)

Method Summary

Modifier and Type	Method	Description
protected T	withAggregationByAsEventDataAttr()	Includes the clicked point's aggregation ("group by") dimension in the event payload, under the attribute name "aggregationBy".
protected T	withBandByAsEventDataAttr()	Includes the clicked point's "band by" dimension in the event payload, under the attribute name "bandBy".
protected T	withXAsEventDataAttr()	Includes the clicked point's X axis category in the event payload, under the attribute name "x".

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

ClickTriggerEvent

public ClickTriggerEvent(String eventName)

Method Details

withXAsEventDataAttr

protected T withXAsEventDataAttr()

Includes the clicked point's X axis category in the event payload, under the attribute name "x".

Returns:

this trigger-event builder, for chaining further configuration

withAggregationByAsEventDataAttr

protected T withAggregationByAsEventDataAttr()

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

Returns:

this trigger-event builder, for chaining further configuration

See Also:

• withBandByAsEventDataAttr()

withBandByAsEventDataAttr

protected T withBandByAsEventDataAttr()

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

Returns:

this trigger-event builder, for chaining further configuration

See Also:

• withAggregationByAsEventDataAttr()