com.vaadin.flow.component.charts.events

Class PointClickEvent

java.lang.Object

java.util.EventObject

com.vaadin.flow.component.ComponentEvent<Chart>

com.vaadin.flow.component.charts.events.PointClickEvent

All Implemented Interfaces:

ClickEvent, HasItem, HasSeries, Serializable

@DomEvent(value="point-click")
public class PointClickEvent
extends ComponentEvent<Chart>
implements ClickEvent, HasItem

The PointClickEvent class stores data for click events on the points of the chart.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
PointClickEvent(Chart source, boolean fromClient, int pageX, int pageY, boolean altKey, boolean ctrlKey, boolean metaKey, boolean shiftKey, int button, double x, double y, int seriesIndex, String category, int pointIndex, String pointId) Constructs a PointClickEvent

Method Summary

Modifier and Type	Method and Description
String	getCategory()
String	getItemId() The ID of the series item that is associated with the event.
int	getItemIndex() Returns the index of the series item, that is associated with this event, in HasSeries.getSeries().
MouseEventDetails	getMouseDetails() Gets the mouse click details
int	getSeriesItemIndex() Returns the index of the series

Methods inherited from class com.vaadin.flow.component.ComponentEvent

getSource, isFromClient, unregisterListener

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.charts.events.ClickEvent

getAbsoluteX, getAbsoluteY, getButton, getxAxisValue, getyAxisValue, isAltKey, isCtrlKey, isMetaKey, isShiftKey

Methods inherited from interface com.vaadin.flow.component.charts.events.HasItem

getItem, getSource

Methods inherited from interface com.vaadin.flow.component.charts.events.HasSeries

getSeries

Constructor Detail

PointClickEvent

public PointClickEvent(Chart source,
                       boolean fromClient,
                       @EventData(value="event.detail.originalEvent.pageX")
                       int pageX,
                       @EventData(value="event.detail.originalEvent.pageY")
                       int pageY,
                       @EventData(value="event.detail.originalEvent.altKey")
                       boolean altKey,
                       @EventData(value="event.detail.originalEvent.ctrlKey")
                       boolean ctrlKey,
                       @EventData(value="event.detail.originalEvent.metaKey")
                       boolean metaKey,
                       @EventData(value="event.detail.originalEvent.shiftKey")
                       boolean shiftKey,
                       @EventData(value="event.detail.originalEvent.button")
                       int button,
                       @EventData(value="event.detail.originalEvent.point.x")
                       double x,
                       @EventData(value="event.detail.originalEvent.point.y")
                       double y,
                       @EventData(value="event.detail.originalEvent.point.series.index")
                       int seriesIndex,
                       @EventData(value="event.detail.originalEvent.point.category")
                       String category,
                       @EventData(value="event.detail.originalEvent.point.index")
                       int pointIndex,
                       @EventData(value="event.detail.originalEvent.point.id")
                       String pointId)

Constructs a PointClickEvent

Parameters:

source -

fromClient -

pageX -

pageY -

altKey -

ctrlKey -

metaKey -

shiftKey -

button -

seriesIndex -

category -

pointIndex -

pointId -

Method Detail

getMouseDetails

public MouseEventDetails getMouseDetails()

Description copied from interface: ClickEvent

Gets the mouse click details

Specified by:

getMouseDetails in interface ClickEvent

Returns:

getSeriesItemIndex

public int getSeriesItemIndex()

Description copied from interface: HasSeries

Returns the index of the series

Specified by:

getSeriesItemIndex in interface HasSeries

Returns:

getCategory

public String getCategory()

Specified by:

getCategory in interface HasItem

getItemIndex

public int getItemIndex()

Description copied from interface: HasItem

Returns the index of the series item, that is associated with this event, in HasSeries.getSeries(). Can be used to identify the item within the series.

Example for ListSeries:

 int itemIndex = event.getItemIndex();
 ListSeries series = (ListSeries) event.getSeries();
 Number datum = series.getData()[itemIndex];
 

Specified by:

getItemIndex in interface HasItem

Returns:

the index of the item in the series

See Also:

HasItem.getItem(), HasItem.getItemId()

getItemId

public String getItemId()

Description copied from interface: HasItem

The ID of the series item that is associated with the event. Can be used to identify the item within the series.

Example for TreeSeries:

 String id = this.getItemId();
 TreeSeries series = (TreeSeries) this.getSeries();
 Optional<TreeSeriesItem> treeItem = series.getData().stream()
   .filter(item -> item.getId().equals(id))
   .findFirst();
 

Only AbstractSeriesItem supports setting an ID. For other types of series items this property will always return null. For AbstractSeriesItem the ID is optional. Unless the developer has explicitly set an ID for the item associated with the event, this property will be null. See HasItem.getItem() or HasItem.getItemIndex() for alternatives.

Specified by:

getItemId in interface HasItem

Returns:

the ID of the series item associated with the event, or null if the series item has no ID

See Also:

HasItem.getItem(), HasItem.getItemIndex()