Mapbox Maps Android/com.mapbox.maps.extension.style.sources.generated/VectorSource/Builder

Builder

Builder for VectorSource.

class Builder(sourceId: String)

Parameters

sourceId

the ID of the source

Constructors

Builder

the ID of the source

fun Builder(sourceId: String)

Functions

attribution

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

fun attribution(value: Expression): VectorSource.Builder

fun attribution(value: String): VectorSource.Builder

bounds

An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: [sw.lng, sw.lat, ne.lng, ne.lat]. When this property is included in a source, no tiles outside of the given bounds are requested by Mapbox GL.

fun bounds(value: Expression): VectorSource.Builder

fun bounds(value: List<Double>): VectorSource.Builder

build

Build the VectorSource.

fun build(): VectorSource

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

maxOverscaleFactorForParentTiles

When a set of tiles for a current zoom level is being rendered and some of the ideal tiles that cover the screen are not yet loaded, parent tile could be used instead. This might introduce unwanted rendering side-effects, especially for raster tiles that are overscaled multiple times. This property sets the maximum limit for how much a parent tile can be overscaled.

fun maxOverscaleFactorForParentTiles(value: Expression): VectorSource.Builder

fun maxOverscaleFactorForParentTiles(value: Long): VectorSource.Builder

maxzoom

Maximum zoom level for which tiles are available, as in the TileJSON spec. Data from tiles at the maxzoom are used when displaying the map at higher zoom levels.

fun maxzoom(value: Expression): VectorSource.Builder

fun maxzoom(value: Long): VectorSource.Builder

minimumTileUpdateInterval

Minimum tile update interval in milliseconds, which is used to throttle the tile update network requests.

fun minimumTileUpdateInterval(value: Expression): VectorSource.Builder

fun minimumTileUpdateInterval(value: Double): VectorSource.Builder

minzoom

Minimum zoom level for which tiles are available, as in the TileJSON spec.

fun minzoom(value: Expression): VectorSource.Builder

fun minzoom(value: Long): VectorSource.Builder

prefetchZoomDelta

When loading a map, if PrefetchZoomDelta is set to any number greater than 0, the map will first request a tile for zoom - delta in a attempt to display a full map at lower resolution as quick as possible. It will get clamped at the tile source minimum zoom. The default delta is 4.

fun prefetchZoomDelta(value: Expression): VectorSource.Builder

fun prefetchZoomDelta(value: Long): VectorSource.Builder

scheme

Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed.

fun scheme(value: Expression): VectorSource.Builder

fun scheme(value: Scheme): VectorSource.Builder

tiles

An array of one or more tile source URLs, as in the TileJSON spec.

fun tiles(value: Expression): VectorSource.Builder

fun tiles(value: List<String>): VectorSource.Builder

tileSet

Add a TileSet to the Source.