android-maps-utils /com.google.maps.android.clustering.algo/GridBasedAlgorithm

GridBasedAlgorithm

open class GridBasedAlgorithm<T : ClusterItem?> : AbstractAlgorithm<T>

Groups markers into a grid for clustering. This algorithm organizes items into a two-dimensional grid, facilitating the formation of clusters based on proximity within each grid cell. The grid size determines the spatial granularity of clustering, and clusters are created by aggregating items within the same grid cell.

The effectiveness of clustering is influenced by the specified grid size, which determines the spatial resolution of the grid. Smaller grid sizes result in more localized clusters, whereas larger grid sizes lead to broader clusters covering larger areas.

Parameters

<T>

The type of ClusterItem to be clustered.

Constructors

GridBasedAlgorithm

constructor()

Functions

open fun addItem(item: T): Boolean

Adds an item to the algorithm

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

Adds a collection of items to the algorithm

open fun clearItems()

open fun getClusters(zoom: Float): Set<out Cluster<T>>

open fun getItems(): Collection<T>

getMaxDistanceBetweenClusteredItems

open fun getMaxDistanceBetweenClusteredItems(): Int

open fun lock()

open fun removeItem(item: T): Boolean

Removes an item from the algorithm

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

Removes a collection of items from the algorithm

setMaxDistanceBetweenClusteredItems

open fun setMaxDistanceBetweenClusteredItems(maxDistance: Int)

open fun unlock()

open fun updateItem(item: T): Boolean

Updates the provided item in the algorithm