Package net.pricefx.common.apibuilder.chart

Class ChartEvents.OnCellClick.CellClickTriggerEvent

Object

AbstractChartEvent<C,ChartEvents.OnCellClick<C>>.AbstractChartEvent.TriggerEvent<ChartEvents.OnCellClick<C>.CellClickTriggerEvent>

CellClickTriggerEvent

Enclosing class:

ChartEvents.OnCellClick<C extends AbstractChartBuilder<?>>

public class ChartEvents.OnCellClick.CellClickTriggerEvent
extends AbstractChartEvent<C,ChartEvents.OnCellClick<C>>.TriggerEvent<ChartEvents.OnCellClick<C>.CellClickTriggerEvent>

The event-payload builder for a cell click, obtained from ChartEvents.OnCellClick.triggerEvent(String) rather than instantiated directly. Unlike a row click, only the clicked cell's own value is provided: the clicked cell must be in the column of a dimension included via withDimensionAsEventDataAttr(String) or withAnyDimensionAsEventDataAttr(), and only that one dimension's value is provided in the event payload.

Field Summary

Fields inherited from class AbstractChartEvent.TriggerEvent

eventName

Constructor Summary

Constructors

Constructor	Description
CellClickTriggerEvent(String eventName)

Method Summary

Modifier and Type	Method	Description
ChartEvents.OnCellClick<C>.CellClickTriggerEvent	withAnyDimensionAsEventDataAttr()	Makes a click on any grid column eligible to fire this event, as a wildcard alternative to naming each dimension with withDimensionAsEventDataAttr(String).
ChartEvents.OnCellClick<C>.CellClickTriggerEvent	withDimensionAsEventDataAttr(String dimensionName)	Makes a click on the given grid dimension's column eligible to fire this event, providing that cell'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

CellClickTriggerEvent

public CellClickTriggerEvent(String eventName)

Method Details

withAnyDimensionAsEventDataAttr

public ChartEvents.OnCellClick<C>.CellClickTriggerEvent withAnyDimensionAsEventDataAttr()

Makes a click on any grid column eligible to fire this event, as a wildcard alternative to naming each dimension with withDimensionAsEventDataAttr(String).

Returns:

this trigger-event builder, for chaining further configuration

withDimensionAsEventDataAttr

public ChartEvents.OnCellClick<C>.CellClickTriggerEvent withDimensionAsEventDataAttr(String dimensionName)

Makes a click on the given grid dimension's column eligible to fire this event, providing that cell's value in the event payload under an attribute name equal to the dimension name. Call this once per dimension to make clickable.

Parameters:

dimensionName - the technical name of the dimension whose column should be clickable

Returns:

this trigger-event builder, for chaining further configuration

See Also:

• withAnyDimensionAsEventDataAttr()