mapbox-maps-android/com.mapbox.maps.plugin.annotation/ClusterFeature

ClusterFeature

class ClusterFeature @RestrictTo(value = [RestrictTo.Scope.LIBRARY]) constructor(featuresetFeature: FeaturesetFeature<FeatureState>)

ClusterFeature is a strongly typed class with cluster related properties in addition to the underlying Feature built from Point.

Parameters

featuresetFeature

FeaturesetFeature that holds original feature representing the cluster.

Constructors

Link copied to clipboard

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

See Any.equals

Link copied to clipboard
open override fun hashCode(): Int

See Any.hashCode

Properties

Link copied to clipboard
val clusterId: String

A unique id for the cluster to be used in conjunction with the cluster inspection methods: com.mapbox.maps.MapboxMap.getGeoJsonClusterExpansionZoom, com.mapbox.maps.MapboxMap.getGeoJsonClusterChildren, com.mapbox.maps.MapboxMap.getGeoJsonClusterLeaves Returns the empty string if no such property exists.

Link copied to clipboard
val originalFeature: Feature

Original feature representing the cluster built from Point.

Link copied to clipboard
val pointCount: Long

Number of original points grouped into this cluster. Returns 0L if no such property exists.

Link copied to clipboard
val pointCountAbbreviated: String

An abbreviated point count. It's a human-readable representation of the amount of items in a cluster. For example, if the cluster has 1823 items pointCountAbbreviated would be "1.8K" Returns the empty string if no such property exists.