public class

VectorTileClickInfo

extends Object
java.lang.Object
   ↳ com.carto.ui.VectorTileClickInfo

Class Overview

A container class that provides information about a click performed on vector tile feature.

Summary

Public Methods
synchronized void delete()
boolean equals(Object obj)
Checks if this object is equal to the specified object.
MapPos getClickPos()
Returns the click position.
ClickType getClickType()
Returns the click type.
VectorTileFeature getFeature()
Returns the clicked feature.
MapPos getFeatureClickPos()
Returns the position on the clicked feature, that is close to the click position.
long getFeatureId()
Returns the id of the clicked feature.
String getFeatureLayerName()
Returns the name of the layer of the clicked feature.
Layer getLayer()
Returns the layer of the vector tile.
MapTile getMapTile()
Returns the tile id of the clicked feature.
int hashCode()
Returns the hash value of this object.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public synchronized void delete ()

public boolean equals (Object obj)

Checks if this object is equal to the specified object.

Parameters
obj The reference object.
Returns
  • True when objects are equal, false otherwise.

public MapPos getClickPos ()

Returns the click position.

Returns
  • The click position in the coordinate system of the data source.

public ClickType getClickType ()

Returns the click type.

Returns
  • The type of the click performed.

public VectorTileFeature getFeature ()

Returns the clicked feature.

Returns
  • The feature on which the click was performed.

public MapPos getFeatureClickPos ()

Returns the position on the clicked feature, that is close to the click position.
For points it will always be the center position, for lines it will be the closest point
on the line, for billboards it will be the anchor point and for polygons it's equal to
getClickPos().

Returns
  • The feature click position in the coordinate system of the data source.

public long getFeatureId ()

Returns the id of the clicked feature.

Returns
  • The id of the clicked feature.

public String getFeatureLayerName ()

Returns the name of the layer of the clicked feature.
Note that this is the layer name in the tile, not the name of style layer.

Returns
  • The name of the layer of the clicked feature.

public Layer getLayer ()

Returns the layer of the vector tile.

Returns
  • The layer of the vector tile.

public MapTile getMapTile ()

Returns the tile id of the clicked feature.

Returns
  • The tile id of the clicked feature.

public int hashCode ()

Returns the hash value of this object.

Returns
  • The hash value of this object.