Builder

class Builder(sourceId: String)

Builder for VectorSource.

Parameters

sourceId

the ID of the source

Constructors

Builder
Link copied to clipboard
fun Builder(sourceId: String)
the ID of the source

Functions

attribution
Link copied to clipboard
fun attribution(value: String): VectorSource.Builder
Contains an attribution to be displayed when the map is shown to a user.
bounds
Link copied to clipboard
fun bounds(value: List<Double> = listOf(-180.0, -85.051129, 180.0, 85.051129)): VectorSource.Builder
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].
build
Link copied to clipboard
fun build(): VectorSource
Build the VectorSource.
equals
Link copied to clipboard
open operator fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open fun hashCode(): Int
maxOverscaleFactorForParentTiles
Link copied to clipboard
fun maxOverscaleFactorForParentTiles(value: Long): VectorSource.Builder
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
Link copied to clipboard
fun maxzoom(value: Long = 22L): VectorSource.Builder
Maximum zoom level for which tiles are available, as in the TileJSON spec.
minimumTileUpdateInterval
Link copied to clipboard
fun minimumTileUpdateInterval(value: Double = 0.0): VectorSource.Builder
Minimum tile update interval in milliseconds, which is used to throttle the tile update network requests.
minzoom
Link copied to clipboard
fun minzoom(value: Long = 0L): VectorSource.Builder
Minimum zoom level for which tiles are available, as in the TileJSON spec.
prefetchZoomDelta
Link copied to clipboard
fun prefetchZoomDelta(value: Long = 4L): VectorSource.Builder
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
Link copied to clipboard
fun promoteId(value: PromoteId): VectorSource.Builder
A property to use as a feature id (for feature state).
scheme
Link copied to clipboard
fun scheme(value: Scheme = Scheme.XYZ): VectorSource.Builder
Influences the y direction of the tile coordinates.
tiles
Link copied to clipboard
fun tiles(value: List<String>): VectorSource.Builder
An array of one or more tile source URLs, as in the TileJSON spec.
tileSet
Link copied to clipboard
fun tileSet(tileSet: TileSet): VectorSource.Builder
Add a TileSet to the Source.
fun tileSet(tilejson: String, tiles: List<String>, block: TileSet.Builder.() -> Unit): VectorSource.Builder
Add a TileSet to the Source, using DSL.
toString
Link copied to clipboard
open fun toString(): String
url
Link copied to clipboard
fun url(value: String): VectorSource.Builder
A URL to a TileJSON resource.
volatile
Link copied to clipboard
fun volatile(value: Boolean = false): VectorSource.Builder
A setting to determine whether a source's tiles are cached locally.

Properties

sourceId
Link copied to clipboard
val sourceId: String
the ID of the source