Package com.vaadin.componentfactory.maps.events

Class PointClickEvent

java.lang.Object

java.util.EventObject

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

com.vaadin.componentfactory.maps.events.PointClickEvent

All Implemented Interfaces:

ClickEvent, HasItem, HasSeries, Serializable

@DomEvent("point-click")
public class PointClickEvent
extends com.vaadin.flow.component.ComponentEvent<Map>
implements ClickEvent, HasItem

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

Version:

$Id: $Id

Author:

Vaadin

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
PointClickEvent(Map 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, String name, int pointIndex)	Constructs a PointClickEvent

Method Summary

Modifier and Type	Method	Description
String	getCategory()
int	getItemIndex()	Returns the index of HasItem.getItem() in HasSeries.getSeries().
MouseEventDetails	getMouseDetails()	Gets the mouse click details
PointProperties	getPointProperties()	Getter for the field pointProperties.
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.componentfactory.maps.events.ClickEvent

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

Methods inherited from interface com.vaadin.componentfactory.maps.events.HasItem

getItem, getSource

Methods inherited from interface com.vaadin.componentfactory.maps.events.HasSeries

getSeries

Constructor Details

PointClickEvent

public PointClickEvent(Map source,
 boolean fromClient,
 @EventData("event.detail.originalEvent.pageX")
 int pageX,
 @EventData("event.detail.originalEvent.pageY")
 int pageY,
 @EventData("event.detail.originalEvent.altKey")
 boolean altKey,
 @EventData("event.detail.originalEvent.ctrlKey")
 boolean ctrlKey,
 @EventData("event.detail.originalEvent.metaKey")
 boolean metaKey,
 @EventData("event.detail.originalEvent.shiftKey")
 boolean shiftKey,
 @EventData("event.detail.originalEvent.button")
 int button,
 @EventData("event.detail.originalEvent.point.x")
 double x,
 @EventData("event.detail.originalEvent.point.y")
 double y,
 @EventData("event.detail.originalEvent.point.series.index")
 int seriesIndex,
 @EventData("event.detail.originalEvent.point.category")
 String category,
 @EventData("event.detail.originalEvent.point.properties && event.detail.originalEvent.point.properties.name")
 String name,
 @EventData("event.detail.originalEvent.point.index")
 int pointIndex)

Constructs a PointClickEvent

Parameters:

source - a Map object.

fromClient - a boolean.

pageX - a int.

pageY - a int.

altKey - a boolean.

ctrlKey - a boolean.

metaKey - a boolean.

shiftKey - a boolean.

button - a int.

x - a double.

y - a double.

seriesIndex - a int.

category - a String object.

name - a String object.

pointIndex - a int.

Method Details

getMouseDetails

public MouseEventDetails getMouseDetails()

Gets the mouse click details

Specified by:

getMouseDetails in interface ClickEvent

Returns:

mouse click details

getSeriesItemIndex

public int getSeriesItemIndex()

Returns the index of the series

Specified by:

getSeriesItemIndex in interface HasSeries

Returns:

index of the series

getCategory

public String getCategory()

Specified by:

getCategory in interface HasItem

getPointProperties

public PointProperties getPointProperties()

Getter for the field pointProperties.

Returns:

a PointProperties object.

getItemIndex

public int getItemIndex()

Returns the index of HasItem.getItem() in HasSeries.getSeries().

Specified by:

getItemIndex in interface HasItem

Returns:

index of the item