VectorSource

fun VectorSource(builder: VectorSource.Builder)

Builder

class Builder(sourceId: String)

Builder for VectorSource.

Companion

object Companion

Static variables and methods.

bindTo

open override fun bindTo(delegate: StyleInterface)

Add the source to the Style.

maxOverscaleFactorForParentTiles

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.

maxzoom

fun maxzoom(value: Long = 22L): VectorSource

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

minimumTileUpdateInterval

fun minimumTileUpdateInterval(value: Double = 0.0): VectorSource

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

minzoom

fun minzoom(value: Long = 0L): VectorSource

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

prefetchZoomDelta

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.

tiles

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

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

toString

open override fun toString(): String

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

url

fun url(value: String): VectorSource

A URL to a TileJSON resource.

volatile

fun volatile(value: Boolean = false): VectorSource

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

attribution

val attribution: String?

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

bounds

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].

maxOverscaleFactorForParentTiles

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.

maxzoom

val maxzoom: Long?

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

minimumTileUpdateInterval

val minimumTileUpdateInterval: Double?

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

minzoom

val minzoom: Long?

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

prefetchZoomDelta

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.

promoteId

val promoteId: PromoteId?

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

scheme

val scheme: Scheme?

Influences the y direction of the tile coordinates.

sourceId

val sourceId: String

The ID of the Source.

tiles

val tiles: List<String>?

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