com.mapbox.mapboxsdk.style.sources

Class GeoJsonOptions

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.String,java.lang.Object>

com.mapbox.mapboxsdk.style.sources.GeoJsonOptions

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class GeoJsonOptions
extends java.util.HashMap<java.lang.String,java.lang.Object>

Builder class for composing GeoJsonSource objects.

See Also:

GeoJsonSource, The online documentation, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GeoJsonOptions()

Method Summary

Modifier and Type	Method and Description
GeoJsonOptions	withBuffer(int buffer) Tile buffer size on each side (measured in 1/512ths of a tile; higher means fewer rendering artifacts near tile edges but slower performance).
GeoJsonOptions	withCluster(boolean cluster) If the data is a collection of point features, setting this to true clusters the points by radius into groups.
GeoJsonOptions	withClusterMaxZoom(int clusterMaxZoom) Max zoom to cluster points on.
GeoJsonOptions	withClusterProperty(java.lang.String propertyName, Expression operatorExpr, Expression mapExpr) An object defining custom properties on the generated clusters if clustering is enabled, aggregating values from clustered points.
GeoJsonOptions	withClusterRadius(int clusterRadius) Radius of each cluster when clustering points, measured in 1/512ths of a tile.
GeoJsonOptions	withLineMetrics(boolean lineMetrics) Initialises whether to calculate line distance metrics.
GeoJsonOptions	withMaxZoom(int maxZoom) Maximum zoom level at which to create vector tiles (higher means greater detail at high zoom levels).
GeoJsonOptions	withMinZoom(int minZoom) Minimum zoom level at which to create vector tiles (lower means more field of view detail at low zoom levels).
GeoJsonOptions	withTolerance(float tolerance) Douglas-Peucker simplification tolerance (higher means simpler geometries and faster performance).

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

entry, equals, hashCode, of, of, of, of, of, of, of, of, of, of, of, ofEntries

Constructor Detail

GeoJsonOptions

public GeoJsonOptions()

Method Detail

withMinZoom

@NonNull
public GeoJsonOptions withMinZoom(int minZoom)

Minimum zoom level at which to create vector tiles (lower means more field of view detail at low zoom levels).

Parameters:

minZoom - the minimum zoom - Defaults to 0.

Returns:

the current instance for chaining

withMaxZoom

@NonNull
public GeoJsonOptions withMaxZoom(int maxZoom)

Maximum zoom level at which to create vector tiles (higher means greater detail at high zoom levels).

Parameters:

maxZoom - the maximum zoom - Defaults to 25.5

Returns:

the current instance for chaining

withBuffer

@NonNull
public GeoJsonOptions withBuffer(int buffer)

Tile buffer size on each side (measured in 1/512ths of a tile; higher means fewer rendering artifacts near tile edges but slower performance).

Parameters:

buffer - the buffer size - Defaults to 128.

Returns:

the current instance for chaining

withLineMetrics

@NonNull
public GeoJsonOptions withLineMetrics(boolean lineMetrics)

Initialises whether to calculate line distance metrics.

Parameters:

lineMetrics - true to calculate line distance metrics.

Returns:

the current instance for chaining

withTolerance

@NonNull
public GeoJsonOptions withTolerance(float tolerance)

Douglas-Peucker simplification tolerance (higher means simpler geometries and faster performance).

Parameters:

tolerance - the tolerance - Defaults to 0.375

Returns:

the current instance for chaining

withCluster

@NonNull
public GeoJsonOptions withCluster(boolean cluster)

If the data is a collection of point features, setting this to true clusters the points by radius into groups.

Parameters:

cluster - cluster? - Defaults to false

Returns:

the current instance for chaining

withClusterMaxZoom

@NonNull
public GeoJsonOptions withClusterMaxZoom(int clusterMaxZoom)

Max zoom to cluster points on.

Parameters:

clusterMaxZoom - clusterMaxZoom cluster maximum zoom - Defaults to one zoom less than maxzoom (so that last zoom features are not clustered)

Returns:

the current instance for chaining

withClusterRadius

@NonNull
public GeoJsonOptions withClusterRadius(int clusterRadius)

Radius of each cluster when clustering points, measured in 1/512ths of a tile.

Parameters:

clusterRadius - cluster radius - Defaults to 50

Returns:

the current instance for chaining

withClusterProperty

@NonNull
public GeoJsonOptions withClusterProperty(java.lang.String propertyName,
                                                   Expression operatorExpr,
                                                   Expression mapExpr)

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]]} or {"property_name": [[operator, accumulated, expression], [map_expression]]}

Parameters:

propertyName - name of the property

operatorExpr - operatorExpr 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. It can either be a literal with single operator, or be a valid expression

mapExpr - map expression produces the value of a single point, it shall be a valid expression

Returns:

the current instance for chaining