Package net.pricefx.common.apibuilder.chart

Class ScatterChart.ScatterOnChartClick

Object

ObjectIdentity

BacklinkBuilder<ScatterChart>

AbstractChartEvent<ScatterChart,ScatterChart.ScatterOnChartClick>

ChartEvents.OnChartClick<ScatterChart,ScatterChart.ScatterOnChartClick>

ScatterOnChartClick

Enclosing class:

ScatterChart

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

The click-event builder for a ScatterChart, obtained from ScatterChart.onClick() rather than instantiated directly.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ScatterChart.ScatterOnChartClick.ScatterTriggerEvent	The event-payload builder for a point click on a ScatterChart, obtained from triggerEvent(String) rather than instantiated directly.

Nested classes/interfaces inherited from class ChartEvents.OnChartClick

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

Nested classes/interfaces inherited from class AbstractChartEvent

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

Field Summary

Fields inherited from class BacklinkBuilder

METHOD_BACK

Fields inherited from class ObjectIdentity

classId, idGenerator, instanceId, invocations, m, NONE, parentObjectIdentity

Constructor Summary

Constructors

Constructor	Description
ScatterOnChartClick()

Method Summary

Modifier and Type	Method	Description
ScatterChart.ScatterOnChartClick.ScatterTriggerEvent	triggerEvent(String eventName)	Names the Dashboard event this click should fire, returning a builder for configuring what data accompanies it.

Methods inherited from class AbstractChartEvent

getThis

Methods inherited from class BacklinkBuilder

back, getParent

Methods inherited from class ObjectIdentity

addInvocation, addInvocation, addInvocationInternal, getClassId

Methods inherited from class Object

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

Constructor Details

ScatterOnChartClick

public ScatterOnChartClick()

Method Details

triggerEvent

public ScatterChart.ScatterOnChartClick.ScatterTriggerEvent triggerEvent(String eventName)

Description copied from class: AbstractChartEvent

Names the Dashboard event this click should fire, returning a builder for configuring what data accompanies it. The concrete return type differs per event kind, for example ChartEvents.OnRowClick.triggerEvent(String) returns a ChartEvents.OnRowClick.RowClickTriggerEvent, which is why this method is declared abstract here rather than implemented once for every event kind.

A Dashboard-wide-unique event name is recommended, typically obtained via api.dashboardWideEvent(String) rather than a hardcoded literal, since Dashboard events are global across browser tabs.

Specified by:

triggerEvent in class AbstractChartEvent<ScatterChart,ScatterChart.ScatterOnChartClick>

Parameters:

eventName - the name of the Dashboard event to fire on click. Must be neither null nor empty.

Returns:

a new AbstractChartEvent.TriggerEvent builder for this event. Never null.