Class PointLegendItemClickEvent

Constructor Detail

• PointLegendItemClickEvent

  public PointLegendItemClickEvent​(Chart source,
                                   boolean fromClient,
                                   @EventData("event.detail.originalEvent.browserEvent.pageX")
                                   int pageX,
                                   @EventData("event.detail.originalEvent.browserEvent.pageY")
                                   int pageY,
                                   @EventData("event.detail.originalEvent.browserEvent.altKey")
                                   boolean altKey,
                                   @EventData("event.detail.originalEvent.browserEvent.ctrlKey")
                                   boolean ctrlKey,
                                   @EventData("event.detail.originalEvent.browserEvent.metaKey")
                                   boolean metaKey,
                                   @EventData("event.detail.originalEvent.browserEvent.shiftKey")
                                   boolean shiftKey,
                                   @EventData("event.detail.originalEvent.button")
                                   int button,
                                   @EventData("event.detail.point.series.index")
                                   int seriesIndex,
                                   @EventData("event.detail.point.category")
                                   String category,
                                   @EventData("event.detail.point.index")
                                   int pointIndex,
                                   @EventData("event.detail.point.id")
                                   String pointId)

  Constructs a SeriesLegendItemClickEvent

  Parameters:

  source -

  fromClient -

Method Detail

• 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 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 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()

• getMouseDetails

  public MouseEventDetails getMouseDetails()

  Description copied from interface: ClickEvent

  Gets the mouse click details

  Specified by:

  getMouseDetails in interface ClickEvent

  Returns: