VectorSource

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: Long): VectorSource

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: Long): VectorSource

minimumTileUpdateInterval

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

fun minimumTileUpdateInterval(value: Double): VectorSource

minzoom

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

fun minzoom(value: Long): VectorSource

prefetchZoomDelta

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. It will get clamped at the tile source minimum zoom. The default delta is 4.

fun prefetchZoomDelta(value: Long): VectorSource

tiles

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

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

toString

Returns a human readable string that includes the cached properties of the source.

open override fun toString(): String

updateProperty

override fun updateProperty(property: PropertyValue<*>, throwRuntimeException: Boolean)

url

A URL to a TileJSON resource. Supported protocols are http:, https:, and mapbox://<Tileset ID>.

fun url(value: String): VectorSource

volatile

A setting to determine whether a source's tiles are cached locally.

fun volatile(value: Boolean): VectorSource

attribution

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

val attribution: String?

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.

val bounds: List<Double>?

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.

val maxOverscaleFactorForParentTiles: Long?

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.

val maxzoom: Long?

minimumTileUpdateInterval

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

val minimumTileUpdateInterval: Double?

minzoom

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

val minzoom: Long?

prefetchZoomDelta

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. It will get clamped at the tile source minimum zoom. The default delta is 4.

val prefetchZoomDelta: Long?

promoteId

A property to use as a feature id (for feature state). Either a property name, or an object of the form {<sourceLayer>: <propertyName>}. If specified as a string for a vector tile source, the same property is used across all its source layers.

val promoteId: PromoteId?

scheme

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

val scheme: Scheme?

sourceId

The ID of the Source.

override val sourceId: String

tiles

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

val tiles: List<String>?

url

A URL to a TileJSON resource. Supported protocols are http:, https:, and mapbox://<Tileset ID>.