Package net.pricefx.common.apibuilder.chart

Class ChartEvents.OnRowClick.RowClickTriggerEvent

Object

AbstractChartEvent<C,ChartEvents.OnRowClick<C>>.AbstractChartEvent.TriggerEvent<ChartEvents.OnRowClick<C>.RowClickTriggerEvent>

RowClickTriggerEvent

Enclosing class:

ChartEvents.OnRowClick<C extends AbstractChartBuilder<?>>

public class ChartEvents.OnRowClick.RowClickTriggerEvent
extends AbstractChartEvent<C,ChartEvents.OnRowClick<C>>.TriggerEvent<ChartEvents.OnRowClick<C>.RowClickTriggerEvent>

The event-payload builder for a row click, obtained from ChartEvents.OnRowClick.triggerEvent(String) rather than instantiated directly. For a row click, every dimension included via withDimensionAsEventDataAttr(String) or withAnyDimensionAsEventDataAttr() is provided in the event payload.

Field Summary

Fields inherited from class AbstractChartEvent.TriggerEvent

eventName

Constructor Summary

Constructors

Constructor	Description
RowClickTriggerEvent(String eventName)

Method Summary

Modifier and Type	Method	Description
ChartEvents.OnRowClick<C>.RowClickTriggerEvent	withAnyDimensionAsEventDataAttr()	Includes every dimension shown in the grid in the event payload, as a wildcard alternative to naming each one with withDimensionAsEventDataAttr(String).
ChartEvents.OnRowClick<C>.RowClickTriggerEvent	withDimensionAsEventDataAttr(String dimensionName)	Includes the given grid dimension's value in the event payload, under an attribute name equal to the dimension name.

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

RowClickTriggerEvent

public RowClickTriggerEvent(String eventName)

Method Details

withAnyDimensionAsEventDataAttr

public ChartEvents.OnRowClick<C>.RowClickTriggerEvent withAnyDimensionAsEventDataAttr()

Includes every dimension shown in the grid in the event payload, as a wildcard alternative to naming each one with withDimensionAsEventDataAttr(String).

Returns:

this trigger-event builder, for chaining further configuration

withDimensionAsEventDataAttr

public ChartEvents.OnRowClick<C>.RowClickTriggerEvent withDimensionAsEventDataAttr(String dimensionName)

Includes the given grid dimension's value in the event payload, under an attribute name equal to the dimension name. Call this once per dimension to include.

Parameters:

dimensionName - the technical name of the dimension to include

Returns:

this trigger-event builder, for chaining further configuration

See Also:

• withAnyDimensionAsEventDataAttr()