com.vaadin.flow.component.charts.events.
Class DrilldownEvent
All Implemented Interfaces:
The DrilldownEvent class stores information on click events in drilldown points
See Also:
-
Field Summary
Fields inherited from class java.util.EventObject
source
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the name of the drilldown
The ID of the series item that is associated with the event.
int
Returns the index of the series item, that is associated with this event, in
HasSeries.getSeries()
.int
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 Details
-
DrilldownEvent
public DrilldownEvent(Chart source, boolean fromClient, @EventData("event.detail.originalEvent.point.drilldown") String drilldown, @EventData("event.detail.originalEvent.point.category") String category, @EventData("event.detail.originalEvent.point.x") Double x, @EventData("event.detail.originalEvent.point.y") Double y, @EventData("event.detail.originalEvent.point.index") int pointIndex, @EventData("event.detail.originalEvent.point.id") String pointId, @EventData("event.detail.originalEvent.point.series.index") int seriesIndex) Construct a ChartDrilldownEvent
Parameters:
source
-
-
-
Method Details
-
getDrilldown
Gets the name of the drilldown
Returns:
-
getxValue
-
getyValue
-
getCategory
Specified by:
getCategory
in interfaceHasItem
-
getSeriesItemIndex
public int getSeriesItemIndex()Description copied from interface:
HasSeries
Returns the index of the series
Specified by:
getSeriesItemIndex
in interfaceHasSeries
Returns:
-
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 interfaceHasItem
Returns:
the index of the item in the series
See Also:
-
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.
-