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

ClusterOptions

data class ClusterOptions @JvmOverloads constructor(val cluster: Boolean = true, val clusterRadius: Long = 50, val circleRadiusExpression: Value? = null, val circleRadius: Double = 18.0, val textColorExpression: Value? = null, val textColor: Int = Color.WHITE, val textSizeExpression: Value? = null, val textSize: Double = 12.0, val textField: Value? = null, val clusterMaxZoom: Long = 14, val clusterMinPoints: Long = 2, val colorLevels: List<Pair<Int, Int>> = listOf(Pair(0, Color.BLUE)), val clusterProperties: HashMap<String, Any>? = null)

Options to show and configure symbol clustering with using PointAnnotationManager or CircleAnnotationManager.

It exposes a minimal of configuration options, a more advanced setup can be created manually with using CircleLayer and SymbolLayers directly.

Constructors

ClusterOptions

@JvmOverloads

fun ClusterOptions(cluster: Boolean = true, clusterRadius: Long = 50, circleRadiusExpression: Value? = null, circleRadius: Double = 18.0, textColorExpression: Value? = null, textColor: Int = Color.WHITE, textSizeExpression: Value? = null, textSize: Double = 12.0, textField: Value? = null, clusterMaxZoom: Long = 14, clusterMinPoints: Long = 2, colorLevels: List<Pair<Int, Int>> = listOf(Pair(0, Color.BLUE)), clusterProperties: HashMap<String, Any>? = null)

Properties

circleRadius

val circleRadius: Double = 18.0

The circle radius of the cluster items in expression, literal(18) by default

circleRadiusExpression

val circleRadiusExpression: Value? = null

The circle radius of the cluster items in expression. Have higher priority than circleRadius, but will apply circleRadius if not set any value.

cluster

val cluster: Boolean = true

If the data is a collection of point features, setting this to true clusters the points by radius into groups. Cluster groups become new Point features in the source with additional properties:

clusterMaxZoom

val clusterMaxZoom: Long = 14

Max zoom on which to cluster points if clustering is enabled. Defaults to one zoom less than maxzoom (so that last zoom features are not clustered). Clusters are re-evaluated at integer zoom levels so setting clusterMaxZoom to 14 means the clusters will be displayed until z15.

clusterMinPoints

val clusterMinPoints: Long = 2

Minimum number of points necessary to form a cluster if clustering is enabled. literal(2) by default.

clusterProperties

val clusterProperties: HashMap<String, Any>? = null

An object defining custom properties on the generated clusters if clustering is enabled, aggregating values from clustered points. Has the form {"property_name": [operator, map_expression]}. operator is any expression function that accepts at least 2 operands (e.g. "+" or "max") — it accumulates the property value from clusters/points the cluster contains; map_expression produces the value of a single point.

clusterRadius

val clusterRadius: Long = 50

Radius of each cluster if clustering is enabled. A value of 512 indicates a radius equal to the width of a tile, 50 by default.

colorLevels

val colorLevels: List<Pair<Int, Int>>

The cluster color levels, which a pair constructed with amount of point and a int color value.

textColor

val textColor: Int

The text color of cluster item in expression. color(Color.WHITE) by default

textColorExpression

val textColorExpression: Value? = null

The text color of cluster item in expression. Have higher priority than textColor, but will apply textColor if not set any value.

textField

val textField: Value? = null

The text field of a cluster item in expression. get("point_count") by default.

textSize

val textSize: Double = 12.0

The text size of cluster item in expression. literal(12) by default.

textSizeExpression

val textSizeExpression: Value? = null

The text size of cluster item in expression. Have higher priority thantextSize, but will apply textSize if not set any value.