VectorSource

class VectorSource(builder: VectorSource.Builder) : Source

A vector tile source.

See also

Constructors

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

Types

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

Builder for VectorSource.

Companion
Link copied to clipboard
object Companion

Static variables and methods.

Functions

bindTo
Link copied to clipboard
open override fun bindTo(delegate: StyleInterface)

Add the source to the Style.

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

maxzoom
Link copied to clipboard
fun maxzoom(value: Long = 22L): VectorSource

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.

minimumTileUpdateInterval
Link copied to clipboard
fun minimumTileUpdateInterval(value: Double = 0.0): VectorSource

Minimum tile update interval in seconds, which is used to throttle the tile update network requests. If the given source supports loading tiles from a server, sets the minimum tile update interval. Update network requests that are more frequent than the minimum tile update interval are suppressed.

minzoom
Link copied to clipboard
fun minzoom(value: Long = 0L): VectorSource

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

prefetchZoomDelta
Link copied to clipboard
fun prefetchZoomDelta(value: Long = 4L): VectorSource

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.

tileNetworkRequestsDelay
Link copied to clipboard
fun tileNetworkRequestsDelay(value: Double = 0.0): VectorSource

For the tiled sources, this property sets the tile network requests delay. The given delay comes in action only during an ongoing animation or gestures. It helps to avoid loading the transient tiles from the network and thus to avoid redundant network requests. Note that tile-network-requests-delay value is superseded with tile-requests-delay property value, if both are provided.

tileRequestsDelay
Link copied to clipboard
fun tileRequestsDelay(value: Double = 0.0): VectorSource

For the tiled sources, this property sets the tile requests delay. The given delay comes in action only during an ongoing animation or gestures. It helps to avoid loading, parsing and rendering of the transient tiles and thus to improve the rendering performance, especially on low-end devices.

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

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

toString
Link copied to clipboard
open override fun toString(): String

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

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

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

volatile
Link copied to clipboard
fun volatile(value: Boolean = false): VectorSource

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

Properties

attribution
Link copied to clipboard
val attribution: String?

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

bounds
Link copied to clipboard
val bounds: List<Double>?

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.

maxOverscaleFactorForParentTiles
Link copied to clipboard
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
val maxzoom: Long?

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.

minimumTileUpdateInterval
Link copied to clipboard
val minimumTileUpdateInterval: Double?

Minimum tile update interval in seconds, which is used to throttle the tile update network requests. If the given source supports loading tiles from a server, sets the minimum tile update interval. Update network requests that are more frequent than the minimum tile update interval are suppressed.

minzoom
Link copied to clipboard
val minzoom: Long?

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

prefetchZoomDelta
Link copied to clipboard
val prefetchZoomDelta: Long?

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.

promoteId
Link copied to clipboard
val promoteId: 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.

scheme
Link copied to clipboard
val scheme: Scheme?

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

sourceId
Link copied to clipboard
val sourceId: String

The ID of the Source.

tileNetworkRequestsDelay
Link copied to clipboard
val tileNetworkRequestsDelay: Double?

For the tiled sources, this property sets the tile network requests delay. The given delay comes in action only during an ongoing animation or gestures. It helps to avoid loading the transient tiles from the network and thus to avoid redundant network requests. Note that tile-network-requests-delay value is superseded with tile-requests-delay property value, if both are provided.

tileRequestsDelay
Link copied to clipboard
val tileRequestsDelay: Double?

For the tiled sources, this property sets the tile requests delay. The given delay comes in action only during an ongoing animation or gestures. It helps to avoid loading, parsing and rendering of the transient tiles and thus to improve the rendering performance, especially on low-end devices.

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

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

url
Link copied to clipboard
val url: String?

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

volatile
Link copied to clipboard
val volatile: Boolean?

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