ImageSource

fun ImageSource(builder: ImageSource.Builder)

Builder

class Builder(val sourceId: String)

Builder for ImageSource.

Companion

object Companion

Static variables and methods.

bindTo

open override fun bindTo(delegate: MapboxStyleManager)

Add the source to the Style.

coordinates

fun coordinates(value: List<List<Double>>): ImageSource

Corners of image specified in longitude, latitude pairs. Note: When using globe projection, the image will be centered at the North or South Pole in the respective hemisphere if the average latitude value exceeds 85 degrees or falls below -85 degrees.

prefetchZoomDelta

fun prefetchZoomDelta(value: Long = 4): ImageSource

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.

toString

open override fun toString(): String

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

url

fun url(value: String): ImageSource

URL that points to an image. If the URL is not specified, the image is expected to be loaded directly during runtime.

coordinates

val coordinates: List<List<Double>>?

Corners of image specified in longitude, latitude pairs. Note: When using globe projection, the image will be centered at the North or South Pole in the respective hemisphere if the average latitude value exceeds 85 degrees or falls below -85 degrees.

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. It will get clamped at the tile source minimum zoom. The default delta is 4.

sourceId

val sourceId: String

The ID of the Source.

url

val url: String?

URL that points to an image. If the URL is not specified, the image is expected to be loaded directly during runtime.

updateImage