Builder

class Builder(sourceId: String)

Builder for GeoJsonSource.

Parameters

sourceId

the ID of the source

Constructors

Builder

fun Builder(sourceId: String)

the ID of the source

Functions

attribution

fun attribution(value: String): GeoJsonSource.Builder

Contains an attribution to be displayed when the map is shown to a user.

buffer

fun buffer(value: Long = 128L): GeoJsonSource.Builder

Size of the tile buffer on each side.

build

fun build(): GeoJsonSource

Build the GeoJsonSource.

cluster

fun cluster(value: Boolean = false): GeoJsonSource.Builder

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

clusterMaxZoom

fun clusterMaxZoom(value: Long): GeoJsonSource.Builder

Max zoom on which to cluster points if clustering is enabled.

clusterProperties

fun clusterProperties(value: HashMap<String, Any>): GeoJsonSource.Builder

An object defining custom properties on the generated clusters if clustering is enabled, aggregating values from clustered points.

clusterProperty

fun clusterProperty(propertyName: String, mapExpr: Expression): GeoJsonSource.Builder

An object defining custom properties on the generated clusters if clustering is enabled, aggregating values from clustered points.

fun clusterProperty(propertyName: String, operatorExpr: Expression, mapExpr: Expression): GeoJsonSource.Builder

An object defining custom properties on the generated clusters if clustering is enabled, aggregating values from clustered points.

clusterRadius

fun clusterRadius(value: Long = 50L): GeoJsonSource.Builder

Radius of each cluster if clustering is enabled.

data

fun data(value: String): GeoJsonSource.Builder

A URL to a GeoJSON file, or inline GeoJSON.

feature

fun feature(value: Feature): GeoJsonSource.Builder

Add a Feature to the GeojsonSource.

featureCollection

fun featureCollection(value: FeatureCollection): GeoJsonSource.Builder

Add a FeatureCollection to the GeojsonSource.

generateId

fun generateId(value: Boolean = false): GeoJsonSource.Builder

Whether to generate ids for the geojson features.

geometry

fun geometry(value: Geometry): GeoJsonSource.Builder

Add a Geometry to the GeojsonSource.

lineMetrics

fun lineMetrics(value: Boolean = false): GeoJsonSource.Builder

Whether to calculate line distance metrics.

maxzoom

fun maxzoom(value: Long = 18L): GeoJsonSource.Builder

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

prefetchZoomDelta

fun prefetchZoomDelta(value: Long = 4L): GeoJsonSource.Builder

When loading a map, if PrefetchZoomDelta is set to any number greater than 0, the map will first request a tile at zoom level lower than zoom - delta, but so that the zoom level is multiple of delta, in an attempt to display a full map at lower resolution as quick as possible.

promoteId

fun promoteId(value: PromoteId): GeoJsonSource.Builder

A property to use as a feature id (for feature state).

tolerance

fun tolerance(value: Double = 0.375): GeoJsonSource.Builder

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

url

fun url(value: String): GeoJsonSource.Builder

A URL to a GeoJSON file, or inline GeoJSON.

Properties

sourceId

val sourceId: String

the ID of the source