MapLibre Native Android/org.maplibre.android.style.sources/ImageSource

ImageSource

Image source, allows a georeferenced raster image to be shown on the map.

The georeferenced image scales and rotates as the user zooms and rotates the map. The geographic location of the raster image content, supplied with LatLngQuad, can be non-axis aligned.

@see the style specification

Constructors

ImageSource

constructor(id: String?, coordinates: LatLngQuad?, url: URL)

Create an ImageSource from coordinates and an image URL

constructor(id: String?, coordinates: LatLngQuad?, uri: URI)

Create an ImageSource from coordinates and an image URI

constructor(id: String?, coordinates: LatLngQuad?, bitmap: Bitmap)

Create an ImageSource from coordinates and a bitmap image

constructor(id: String?, coordinates: LatLngQuad?, @DrawableRes resourceId: Int)

Create an ImageSource from coordinates and a bitmap image resource

Properties

nativePtr

val nativePtr: Long

uri

val uri: String?

Get the source URI.

url

val url: String?

Functions

getAttribution

@NonNull

open fun getAttribution(): String

Retrieve the source attribution.

getId

@NonNull

open fun getId(): String

Retrieve the source id

getMaxOverscaleFactorForParentTiles

@Nullable

open fun getMaxOverscaleFactorForParentTiles(): Int?

Retrieve current maximum overscale factor for parent tiles.

getMinimumTileUpdateInterval

@NonNull

open fun getMinimumTileUpdateInterval(): Long

Retrieve the minimum tile update interval, which is used to throttle the tile update network requests.

getPrefetchZoomDelta

@Nullable

open fun getPrefetchZoomDelta(): Int?

Retrieve current pre-fetching zoom delta.

isVolatile

@NonNull

open fun isVolatile(): Boolean

Retrieve whether or not the fetched tiles for the given source should be stored in the local cache

setCoordinates

fun setCoordinates(latLngQuad: LatLngQuad?)

Updates the latitude and longitude of the four corners of the image

setDetached

open fun setDetached()

setImage

fun setImage(bitmap: Bitmap)

Updates the source image to a bitmap

fun setImage(@DrawableRes resourceId: Int)

Updates the source image to a bitmap image resource

setMaxOverscaleFactorForParentTiles

open fun setMaxOverscaleFactorForParentTiles(@Nullable maxOverscaleFactor: Int?)

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. This might introduce unwanted rendering side-effects, especially for raster tiles that are overscaled multiple times. This method sets the maximum limit for how much a parent tile can be overscaled.

setMinimumTileUpdateInterval

open fun setMinimumTileUpdateInterval(interval: Long)

Sets the minimum tile update interval, which is used to throttle the tile update network requests.

setPrefetchZoomDelta

open fun setPrefetchZoomDelta(@Nullable delta: Int?)

Set the tile pre-fetching zoom delta for current source. Pre-fetching makes sure that a low-resolution tile at the (current_zoom_level - delta) is rendered as soon as possible at the expense of a little bandwidth. If delta has not been set or set to null, it will use the value in MapLibreMap instance.

setUri

fun setUri(uri: URI)

fun setUri(uri: String?)

Updates the source image URI.

setUrl

fun ~~setUrl~~(url: URL)

fun ~~setUrl~~(url: String?)

Updates the source image url

setVolatile

open fun setVolatile(value: Boolean)

Set a flag defining whether or not the fetched tiles for the given source should be stored in the local cache