Package net.pricefx.common.apibuilder.chart

Class BubbleChart.BubbleOnChartClick.BubbleTriggerEvent

Object

AbstractChartEvent<BubbleChart,BubbleChart.BubbleOnChartClick>.AbstractChartEvent.TriggerEvent<BubbleChart.BubbleOnChartClick.BubbleTriggerEvent>

ChartEvents.OnChartClick<BubbleChart,BubbleChart.BubbleOnChartClick>.ChartEvents.OnChartClick.ClickTriggerEvent<BubbleChart.BubbleOnChartClick.BubbleTriggerEvent>

BubbleTriggerEvent

Enclosing class:

BubbleChart.BubbleOnChartClick

public class BubbleChart.BubbleOnChartClick.BubbleTriggerEvent
extends ChartEvents.OnChartClick<BubbleChart,BubbleChart.BubbleOnChartClick>.ClickTriggerEvent<BubbleChart.BubbleOnChartClick.BubbleTriggerEvent>

The event-payload builder for a bubble click on a BubbleChart, obtained from BubbleChart.BubbleOnChartClick.triggerEvent(String) rather than instantiated directly.

Field Summary

Fields inherited from class AbstractChartEvent.TriggerEvent

eventName

Constructor Summary

Constructors

Constructor	Description
BubbleTriggerEvent(String eventName)

Method Summary

Modifier and Type	Method	Description
BubbleChart.BubbleOnChartClick.BubbleTriggerEvent	withAggregationByAsEventDataAttr()	Includes the clicked bubble's aggregation ("group by") dimension in the event payload.
BubbleChart.BubbleOnChartClick.BubbleTriggerEvent	withBandByAsEventDataAttr()	Includes the clicked bubble's "band by" dimension in the event payload.

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

BubbleTriggerEvent

public BubbleTriggerEvent(String eventName)

Method Details

withAggregationByAsEventDataAttr

public BubbleChart.BubbleOnChartClick.BubbleTriggerEvent withAggregationByAsEventDataAttr()

Includes the clicked bubble's aggregation ("group by") dimension in the event payload. The event attribute name will be 'aggregationBy'

Overrides:

withAggregationByAsEventDataAttr in class ChartEvents.OnChartClick<BubbleChart,BubbleChart.BubbleOnChartClick>.ClickTriggerEvent<BubbleChart.BubbleOnChartClick.BubbleTriggerEvent>

Returns:

this trigger-event builder, for chaining further configuration

See Also:

• ChartEvents.OnChartClick.ClickTriggerEvent.withBandByAsEventDataAttr()

withBandByAsEventDataAttr

public BubbleChart.BubbleOnChartClick.BubbleTriggerEvent withBandByAsEventDataAttr()

Includes the clicked bubble's "band by" dimension in the event payload. The event attribute name will be 'bandBy'

Overrides:

withBandByAsEventDataAttr in class ChartEvents.OnChartClick<BubbleChart,BubbleChart.BubbleOnChartClick>.ClickTriggerEvent<BubbleChart.BubbleOnChartClick.BubbleTriggerEvent>

Returns:

this trigger-event builder, for chaining further configuration

See Also:

• ChartEvents.OnChartClick.ClickTriggerEvent.withAggregationByAsEventDataAttr()