Package com.vaadin.flow.component.charts.events

Interface HasItem

All Superinterfaces:
HasSeries, Serializable
All Known Implementing Classes:
DrilldownEvent, PointClickEvent, PointLegendItemClickEvent, PointMouseOutEvent, PointMouseOverEvent, PointRemoveEvent, PointSelectEvent, PointUnselectEvent, PointUpdateEvent
public interface HasItem extends HasSeries
Indicates that an event has an associated item

  • Method Details

    • getSource

      Chart getSource()
      Specified by:
      getSource in interface HasSeries

    • getCategory

      String getCategory()

    • getItemIndex

      int getItemIndex()
      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];
      Returns:
      the index of the item in the series
      See Also:

    • getItemId

      String getItemId()
      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 and Node support 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 getItem() or getItemIndex() for alternatives.

      Returns:
      the ID of the series item associated with the event, or null if the series item has no ID
      See Also:

    • getItem

      default DataSeriesItem getItem()
      Returns the data series item that this event is associated with.

      NOTE: This method only works with series of type DataSeries. For other series an UnsupportedOperationException will be thrown. See getItemIndex() or getItemId() for alternatives.

      Returns:
      the DataSeriesItem that is associated with this event
      Throws:
      UnsupportedOperationException - when using this method with a series that is not a DataSeries
      See Also: