Builder

class Builder(sourceId: String)

Builder for RasterSource.

Parameters

sourceId

the ID of the source

Constructors

Builder

fun Builder(sourceId: String)

the ID of the source

Functions

attribution

fun attribution(value: String): RasterSource.Builder

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

bounds

fun bounds(value: List<Double> = listOf(-180.0, -85.051129, 180.0, 85.051129)): RasterSource.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

fun build(): RasterSource

Build the RasterSource.

maxOverscaleFactorForParentTiles

fun maxOverscaleFactorForParentTiles(value: Long): RasterSource.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

fun maxzoom(value: Long = 22L): RasterSource.Builder

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

minimumTileUpdateInterval

fun minimumTileUpdateInterval(value: Double = 0.0): RasterSource.Builder

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

minzoom

fun minzoom(value: Long = 0L): RasterSource.Builder

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

prefetchZoomDelta

fun prefetchZoomDelta(value: Long = 4L): RasterSource.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.

scheme

fun scheme(value: Scheme = Scheme.XYZ): RasterSource.Builder

Influences the y direction of the tile coordinates.

tiles

fun tiles(value: List<String>): RasterSource.Builder

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

tileSet

fun tileSet(tileSet: TileSet): RasterSource.Builder

Add a TileSet to the Source.

fun tileSet(tilejson: String, tiles: List<String>, block: TileSet.Builder.() -> Unit): RasterSource.Builder

Add a TileSet to the Source, using DSL.

tileSize