mapbox-maps-android/com.mapbox.maps/Snapshotter

Snapshotter

Snapshotter is high-level component responsible for taking map snapshot with given MapSnapshotOptions. The Snapshotter is valid until destroy is called.

Constructors

Snapshotter

@JvmOverloads

fun Snapshotter(context: Context, options: MapSnapshotOptions, overlayOptions: SnapshotOverlayOptions = SnapshotOverlayOptions())

Types

Companion

object Companion

Static variables and methods.

Functions

cameraForCoordinates

fun cameraForCoordinates(coordinates: List<Point>, padding: EdgeInsets?, bearing: Double?, pitch: Double?): CameraOptions

Convenience method that returns the camera options object for given arguments

cancel

fun cancel()

Cancel taking snapshot if it was running.

coordinateBoundsForCamera

fun coordinateBoundsForCamera(options: CameraOptions): CoordinateBounds

Returns the coordinate bounds for a given camera.

destroy

fun destroy()

Destroy snapshotter.

getCameraState

fun getCameraState(): CameraState

Get the current camera state.

getSize

fun getSize(): Size

Gets the size of the snapshot

getStyleJson

fun getStyleJson(): String

Get the JSON serialization string of the current Mapbox Style in use.

getStyleUri

fun getStyleUri(): String

Get the URI of the current Mapbox Style in use.

setCamera

fun setCamera(cameraOptions: CameraOptions)

Set the camera options of the snapshot.

setSize

fun setSize(size: Size)

Sets the size of the snapshot

setStyleJson

fun setStyleJson(styleJson: String)

Load the style from a provided JSON string.

setStyleListener

fun setStyleListener(listener: SnapshotStyleListener)

Set SnapshotStyleListener to listen to all events style related.

setStyleUri

fun setStyleUri(styleUri: String)

Set the URI of the current Mapbox Style in use.

start

fun start(overlayCallback: SnapshotOverlayCallback? = null, resultCallback: SnapshotResultCallback)

Request a new snapshot. If there is a running snapshot request, it is cancelled and SnapshotResultCallback.onSnapshotResult for it will be called with snapshot=NULL.

tileCover

@MapboxExperimental

fun tileCover(tileCoverOptions: TileCoverOptions, cameraOptions: CameraOptions?): MutableList<CanonicalTileID>

Returns tileIDs that cover current map camera