ImageSource

An image data source.

See also

Constructors

Link copied to clipboard

Types

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

Builder for ImageSource.

Link copied to clipboard
object Companion

Static variables and methods.

Functions

Link copied to clipboard
open override fun bindTo(delegate: MapboxStyleManager)

Add the source to the Style.

Link copied to clipboard
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.

Link copied to clipboard
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. Default value: 4.

Link copied to clipboard
open override fun toString(): String

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

Link copied to clipboard
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.

Properties

Link copied to clipboard
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.

Link copied to clipboard

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. Default value: 4.

Link copied to clipboard
val sourceId: String

The ID of the Source.

Link copied to clipboard
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.

Extensions

Link copied to clipboard
fun ImageSource.updateImage(bitmap: Bitmap)

Updates the image of an image style source with Bitmap provided.

fun ImageSource.updateImage(image: Image)

Updates the image of an image style source with Image provided.