OpenMapView/de.afarber.openmapview.clustering/ClusterManager

ClusterManager

class ClusterManager<T : ClusterItem>(context: Context, map: OpenMapView) : OnCameraIdleListener, OnMarkerClickListener(source)

Groups nearby markers into clusters that show their count. Clusters are computed again when the map stops at a new integer zoom level.

The manager is the map's camera idle and marker click listener:

val clusterManager = ClusterManager<Shop>(context, mapView)
mapView.setOnCameraIdleListener(clusterManager)
mapView.setOnMarkerClickListener(clusterManager)
clusterManager.addItems(shops)
clusterManager.cluster()

Tapping a cluster zooms in to show its items, unless an OnClusterClickListener returns true.

Parameters

context

Context for the screen density

map

The map to draw the markers on

Type Parameters

The type of the items

Constructors

ClusterManager

constructor(context: Context, map: OpenMapView)

Types

ClusterIconProvider

fun interface ClusterIconProvider<T : ClusterItem>

Provides the icon of a cluster marker, e.g. to draw clusters in your own style.

ClusterItemIconProvider

fun interface ClusterItemIconProvider<T : ClusterItem>

Provides the icon of an item's marker, or null for the default marker.

OnClusterClickListener

fun interface OnClusterClickListener<T : ClusterItem>

Called when a cluster marker is tapped.

OnClusterItemClickListener

fun interface OnClusterItemClickListener<T : ClusterItem>

Called when the marker of a single item is tapped.

Properties

clusterIconProvider

var clusterIconProvider: ClusterManager.ClusterIconProvider<T>?

Draws the cluster markers, or null for circles with the count.

clusterItemIconProvider

var clusterItemIconProvider: ClusterManager.ClusterItemIconProvider<T>?

Draws the item markers, or null for the default marker.

maxDistanceDp

var maxDistanceDp: Int

How close items must be to share a cluster, in dp on the screen. Default is 100.

minClusterSize

var minClusterSize: Int

The smallest group drawn as a cluster; smaller groups show their items' markers. Default is 4.

Functions

addItem

fun addItem(item: T): Boolean

Adds an item. Call cluster to show it.

addItems

fun addItems(items: Collection<T>): Boolean

Adds items. Call cluster to show them.

clearItems

fun clearItems()

Removes all items. Call cluster to update the map.

cluster

fun cluster()

Computes the clusters for the current zoom level and draws their markers.

getItems

fun getItems(): Collection<T>

Returns the items of the manager.

onCameraIdle

open override fun onCameraIdle()

Clusters again when the camera stops at another integer zoom level.

onMarkerClick

open override fun onMarkerClick(marker: Marker): Boolean

Handles taps on the manager's markers; returns false for other markers.

removeItem

fun removeItem(item: T): Boolean

Removes an item. Call cluster to update the map.

removeItems

fun removeItems(items: Collection<T>): Boolean

Removes items. Call cluster to update the map.

setOnClusterClickListener

fun setOnClusterClickListener(listener: ClusterManager.OnClusterClickListener<T>?)

Sets a listener called when a cluster is tapped.

setOnClusterItemClickListener

fun setOnClusterItemClickListener(listener: ClusterManager.OnClusterItemClickListener<T>?)

Sets a listener called when the marker of a single item is tapped.