ImageSource

class ImageSource(builder: ImageSource.Builder) : Source

An image data source.

See also

Constructors

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

Types

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

Builder for ImageSource.

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.

coordinates
Link copied to clipboard
fun coordinates(value: List<List<Double>>): ImageSource

Corners of image specified in longitude, latitude pairs.

prefetchZoomDelta
Link copied to clipboard
fun prefetchZoomDelta(value: Long = 4L): 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
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): ImageSource

URL that points to an image.

Properties

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

Corners of image specified in longitude, latitude pairs.

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.

sourceId
Link copied to clipboard
val sourceId: String

The ID of the Source.

url
Link copied to clipboard
val url: String?

URL that points to an image.

Extensions

updateImage
Link copied to clipboard
fun ImageSource.updateImage(image: Image)

Updates the image of an image style source.