Interface ClusterizedPlacemarkCollection

com.yandex.mapkit.map

public interface ClusterizedPlacemarkCollection extends MapObject

All Superinterfaces:
MapObject

A collection that displays large groups of placemarks efficiently.

Placemarks that are too close to each other with current zoom are rendered as a single cluster. Placemarks and clusters are not shown until clusterPlacemarks method is called explicitly.

Methods

PlacemarkMapObject addEmptyPlacemark(@NonNull Point point)

Creates a new empty placemark and adds it to the current collection.

List< PlacemarkMapObject > addEmptyPlacemarks(@NonNull List< Point > points)

Creates new empty placemarks and adds them to the current collection.

PlacemarkMapObject addPlacemark(@NonNull Point point)

Creates a new placemark with the default icon and style, and adds it to the current collection.

PlacemarkMapObject addPlacemark(@NonNull Point point, @NonNull ImageProvider image)

Creates a new placemark with the default style and adds it to the current collection.

PlacemarkMapObject addPlacemark(@NonNull Point point, @NonNull ImageProvider image, @NonNull IconStyle style)

Creates a new placemark and adds it to the current collection.

PlacemarkMapObject addPlacemark(@NonNull Point point, @NonNull ViewProvider view)

Creates a new view placemark with default style and adds it to the current collection.

PlacemarkMapObject addPlacemark(@NonNull Point point, @NonNull ViewProvider view, @NonNull IconStyle style)

Creates a new view placemark and adds it to the current collection.

PlacemarkMapObject addPlacemark(@NonNull Point point, @NonNull AnimatedImageProvider animatedImage, @NonNull IconStyle style)

Creates a new placemark with animated icon and adds it to the current collection.

PlacemarkMapObject addPlacemark(@NonNull Point point, @NonNull AnimatedModelProvider animatedModel, @NonNull ModelStyle style)

Creates a new placemark with animated model and adds it to the current collection.

List< PlacemarkMapObject > addPlacemarks(@NonNull List< Point > points, @NonNull ImageProvider image, @NonNull IconStyle style)

Creates new placemarks and adds them to the current collection.

void clear()

Remove both clusters and placemarks from collection.

void clusterPlacemarks(double clusterRadius, int minZoom)

Updates clustered representations of placemark groups.

Method Detail

addEmptyPlacemark

public PlacemarkMapObject addEmptyPlacemark (@NonNull Point point)

Creates a new empty placemark and adds it to the current collection.

Hint: to add a large amount of empty placemarks use addEmptyPlacemarks method.

addEmptyPlacemarks

public List< PlacemarkMapObject > addEmptyPlacemarks (@NonNull List< Point > points)

Creates new empty placemarks and adds them to the current collection.

Relevant for Android: this method provides better performance for adding a large number of empty placemarks than multiple calls of addEmptyPlacemark.

addPlacemark

public PlacemarkMapObject addPlacemark (@NonNull Point point)

Creates a new placemark with the default icon and style, and adds it to the current collection.

addPlacemark

public PlacemarkMapObject addPlacemark (@NonNull Point point, @NonNull ImageProvider image)

Creates a new placemark with the default style and adds it to the current collection.

addPlacemark

public PlacemarkMapObject addPlacemark (@NonNull Point point, @NonNull ImageProvider image, @NonNull IconStyle style)

Creates a new placemark and adds it to the current collection.

Hint: to add a large amount of placemarks use addPlacemarks method.

addPlacemark

public PlacemarkMapObject addPlacemark (@NonNull Point point, @NonNull ViewProvider view)

Creates a new view placemark with default style and adds it to the current collection.

addPlacemark

public PlacemarkMapObject addPlacemark (@NonNull Point point, @NonNull ViewProvider view, @NonNull IconStyle style)

Creates a new view placemark and adds it to the current collection.

addPlacemark

public PlacemarkMapObject addPlacemark (@NonNull Point point, @NonNull AnimatedImageProvider animatedImage, @NonNull IconStyle style)

Creates a new placemark with animated icon and adds it to the current collection.

addPlacemark

public PlacemarkMapObject addPlacemark (@NonNull Point point, @NonNull AnimatedModelProvider animatedModel, @NonNull ModelStyle style)

Creates a new placemark with animated model and adds it to the current collection.

addPlacemarks

public List< PlacemarkMapObject > addPlacemarks (@NonNull List< Point > points, @NonNull ImageProvider image, @NonNull IconStyle style)

Creates new placemarks and adds them to the current collection.

Relevant for Android: this method provides better performance for adding a large number of placemarks than multiple calls of addPlacemark.

clear

public void clear ()

Remove both clusters and placemarks from collection.

clusterPlacemarks

public void clusterPlacemarks (double clusterRadius, int minZoom)

Updates clustered representations of placemark groups.

This method must be called explicitly to render placemarks and clusters when collection is created and update them after collection change.
Parameters:
clusterRadius

Minimal distance in units between objects that remain separate. The size of the unit is equal to the size of a pixel when the camera position's tilt is equal to 0 and the scale factor is equal to 1.

minZoom

Minimal zoom level that displays clusters. All placemarks will be rendered separately at more detailed zoom levels. The value will be clipped between 0 and 19 (most detailed zoom).