Class PointMouseOverEvent
- java.lang.Object
-
- java.util.EventObject
-
- com.vaadin.flow.component.ComponentEvent<Chart>
-
- com.vaadin.flow.component.charts.events.PointMouseOverEvent
-
- All Implemented Interfaces:
HasItem
,HasSeries
,Serializable
@DomEvent("point-mouse-over") public class PointMouseOverEvent extends ComponentEvent<Chart> implements HasItem
Fired when the mouse pointer moves within the neighborhood of a point- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor Description PointMouseOverEvent(Chart source, boolean fromClient, int seriesIndex, int pointIndex, String pointId, String category)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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, inHasSeries.getSeries()
.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
-
-
-
-
Constructor Detail
-
PointMouseOverEvent
public PointMouseOverEvent(Chart source, boolean fromClient, @EventData("event.detail.originalEvent.target.series.index") int seriesIndex, @EventData("event.detail.originalEvent.target.index") int pointIndex, @EventData("event.detail.originalEvent.target.id") String pointId, @EventData("event.detail.originalEvent.target.category") String category)
-
-
Method Detail
-
getCategory
public String getCategory()
- Specified by:
getCategory
in interfaceHasItem
-
getItemIndex
public int getItemIndex()
Description copied from interface:HasItem
Returns the index of the series item, that is associated with this event, inHasSeries.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 interfaceHasItem
- 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
NodeSeries
:String id = this.getItemId(); NodeSeries series = (NodeSeries) this.getSeries(); Optional<Node> nodeForId = series.getNodes().stream() .filter(node -> node.getId().equals(id)) .findFirst();
Only
AbstractSeriesItem
andNode
support setting an ID. For other types of series items this property will always return null. ForAbstractSeriesItem
the ID is optional. Unless the developer has explicitly set an ID for the item associated with the event, this property will be null. SeeHasItem.getItem()
orHasItem.getItemIndex()
for alternatives.- Specified by:
getItemId
in interfaceHasItem
- 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()
-
getSeriesItemIndex
public int getSeriesItemIndex()
Description copied from interface:HasSeries
Returns the index of the series- Specified by:
getSeriesItemIndex
in interfaceHasSeries
- Returns:
-
-