Package com.vaadin.flow.component.map.events

Class MapClusterClickEvent

java.lang.Object

java.util.EventObject

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

com.vaadin.flow.component.map.events.MapClusterClickEvent

All Implemented Interfaces:

Serializable

@DomEvent("map-cluster-click")
public class MapClusterClickEvent
extends com.vaadin.flow.component.ComponentEvent<MapBase>

Provides data for click events on a cluster of features

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
MapClusterClickEvent(Map source, boolean fromClient, tools.jackson.databind.node.ArrayNode featureIds, String layerId, int pageX, int pageY, boolean altKey, boolean ctrlKey, boolean metaKey, boolean shiftKey, int button)

Method Summary

Modifier and Type	Method	Description
List<Feature>	getFeatures()	List of map features in the cluster.
VectorLayer	getLayer()	Gets the layer that contains the cluster's features.
MouseEventDetails	getMouseDetails()	Gets the click's mouse event details.
VectorSource	getVectorSource()	Gets the source that contains the cluster's features.

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

Constructor Details

MapClusterClickEvent

public MapClusterClickEvent(Map source,
 boolean fromClient,
 @EventData("event.detail.features.map(feature => feature.id)")
 tools.jackson.databind.node.ArrayNode featureIds,
 @EventData("event.detail.layer.id")
 String layerId,
 @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)

Method Details

getFeatures

public List<Feature> getFeatures()

List of map features in the cluster.

Returns:

the list of features in the cluster

getLayer

public VectorLayer getLayer()

Gets the layer that contains the cluster's features.

Returns:

the layer

getVectorSource

public VectorSource getVectorSource()

Gets the source that contains the cluster's features.

Returns:

the source

getMouseDetails

public MouseEventDetails getMouseDetails()

Gets the click's mouse event details.

Returns:

mouse event details