MapLibre Native Android/org.maplibre.android.snapshotter/MapSnapshotter

MapSnapshotter

open class MapSnapshotter(context: Context, options: MapSnapshotter.Options)(source)

The map snapshotter creates a large of the map, rendered off the UI thread. The snapshotter itself must be used on the UI thread (for access to the main looper)

Constructors

MapSnapshotter

constructor(context: Context, options: MapSnapshotter.Options)

Types

Companion

object Companion

ErrorHandler

fun interface ErrorHandler

Can be used to get notified of errors in snapshot generation

Observer

interface Observer

Can be used to get notified on snapshotter style loading completion.

Options

class Options(width: Int, height: Int)

MapSnapshotter options

SnapshotReadyCallback

fun interface SnapshotReadyCallback

Get notified on snapshot completion.

Functions

addImage

fun addImage(name: String, bitmap: Bitmap, sdf: Boolean)

Adds an image to be used in the snapshotter's style

cancel

fun cancel()

Must be called in on the thread the object was created on.

getGlobalState

fun getGlobalState(): JsonObject

Get a snapshot of the current global state of the style that is used by the snapshotter, used by the global-state expression.

getLayer

fun getLayer(layerId: String): Layer?

Returns Layer of a style that is used by a snapshotter

getSource

fun getSource(sourceId: String): Source?

Returns Source of a style that is used by a snapshotter

setCameraPosition

external fun setCameraPosition(cameraPosition: CameraPosition?)

Updates the snapshotter with a new CameraPosition

setGlobalStateProperty

fun setGlobalStateProperty(name: String, value: JsonElement?)

Set a global state property on the style that is used by the snapshotter, used by the global-state expression.

setObserver

fun setObserver(observer: MapSnapshotter.Observer?)

Sets observer for a snapshotter

setPadding

external fun setPadding(left: Int, top: Int, right: Int, bottom: Int)

Updates the snapshotter padding with a new IntArray

setRegion

external fun setRegion(region: LatLngBounds?)

Updates the snapshotter with a new LatLngBounds

setSize

external fun setSize(width: Int, height: Int)

Updates the snapshotter with a new size

setStyleJson

external fun setStyleJson(styleJson: String?)

Updates the snapshotter with a new style json

setStyleUrl

external fun setStyleUrl(styleUrl: String?)

Updates the snapshotter with a new style url

start

@JvmOverloads

fun start(callback: MapSnapshotter.SnapshotReadyCallback, errorHandler: MapSnapshotter.ErrorHandler? = null)

Starts loading and rendering the snapshot. The callbacks will be fired on the calling thread.