VectorSource

A vector tile source.

class VectorSource(builder: VectorSource.Builder) : Source

See also

Constructors

VectorSource
Link copied to clipboard
fun VectorSource(builder: VectorSource.Builder)

Types

Builder
Link copied to clipboard

Builder for VectorSource.

class Builder(sourceId: String)
Companion
Link copied to clipboard

Static variables and methods.

object Companion

Functions

bindTo
Link copied to clipboard

Add the source to the Style.

open override fun bindTo(delegate: StyleInterface)
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
getCachedSourceProperties
Link copied to clipboard
override fun getCachedSourceProperties(): Value
hashCode
Link copied to clipboard
open override fun hashCode(): Int
maxOverscaleFactorForParentTiles
Link copied to clipboard

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
fun maxOverscaleFactorForParentTiles(value: Long): VectorSource
maxzoom
Link copied to clipboard

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
fun maxzoom(value: Long): VectorSource
minimumTileUpdateInterval
Link copied to clipboard

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

fun minimumTileUpdateInterval(value: Expression): VectorSource
fun minimumTileUpdateInterval(value: Double): VectorSource
minzoom
Link copied to clipboard

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

fun minzoom(value: Expression): VectorSource
fun minzoom(value: Long): VectorSource
prefetchZoomDelta
Link copied to clipboard

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
fun prefetchZoomDelta(value: Long): VectorSource
tiles
Link copied to clipboard

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

fun tiles(value: Expression): VectorSource
fun tiles(value: List<String>): VectorSource
toString
Link copied to clipboard

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

open override fun toString(): String
updateProperty
Link copied to clipboard
override fun updateProperty(property: PropertyValue<*>, throwRuntimeException: Boolean)
url
Link copied to clipboard

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

fun url(value: Expression): VectorSource
fun url(value: String): VectorSource
volatile
Link copied to clipboard

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

fun volatile(value: Expression): VectorSource
fun volatile(value: Boolean): VectorSource

Properties

attribution
Link copied to clipboard

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

val attribution: String?
attributionAsExpression
Link copied to clipboard

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

val attributionAsExpression: Expression?
bounds
Link copied to clipboard

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>?
boundsAsExpression
Link copied to clipboard

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 boundsAsExpression: Expression?
maxOverscaleFactorForParentTiles
Link copied to clipboard

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?

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.

maxzoom
Link copied to clipboard

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?
maxzoomAsExpression
Link copied to clipboard

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 maxzoomAsExpression: Expression?
minimumTileUpdateInterval
Link copied to clipboard

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

val minimumTileUpdateInterval: Double?
minimumTileUpdateIntervalAsExpression
Link copied to clipboard

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

val minimumTileUpdateIntervalAsExpression: Expression?
minzoom
Link copied to clipboard

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

val minzoom: Long?
minzoomAsExpression
Link copied to clipboard

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

val minzoomAsExpression: Expression?
prefetchZoomDelta
Link copied to clipboard

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.

val prefetchZoomDelta: Long?
prefetchZoomDeltaAsExpression
Link copied to clipboard

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.

val prefetchZoomDeltaAsExpression: Expression?
scheme
Link copied to clipboard

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

val scheme: Scheme?
schemeAsExpression
Link copied to clipboard

Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed. This is an Expression representation of this Property.

val schemeAsExpression: Expression?
sourceId
Link copied to clipboard

The ID of the Source.

override val sourceId: String
tiles
Link copied to clipboard

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

val tiles: List<String>?
tilesAsExpression
Link copied to clipboard

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

val tilesAsExpression: Expression?
url
Link copied to clipboard

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

val url: String?
urlAsExpression
Link copied to clipboard

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

val urlAsExpression: Expression?
volatile
Link copied to clipboard

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

val volatile: Boolean?
volatileAsExpression
Link copied to clipboard

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

val volatileAsExpression: Expression?