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

Snapshotter

Snapshotter is high-level component responsible for taking map snapshot with given MapSnapshotOptions.

Constructors

Snapshotter

androidJvm

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

Types

Companion

androidJvm

object Companion

Static variables and methods.

Functions

cameraForCoordinates

androidJvm

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

Convenience method that returns the camera options object for given arguments

cancel

androidJvm

fun cancel()

Cancel taking snapshot if it was running.

clearData

androidJvm

fun clearData(callback: AsyncOperationResultCallback)

Clears temporary map data.

coordinateBoundsForCamera

androidJvm

fun coordinateBoundsForCamera(options: CameraOptions): CoordinateBounds

Returns the coordinate bounds for a given camera.

destroy

androidJvm

fun destroy()

Destroy snapshotter.

equals

androidJvm

open operator fun equals(other: Any?): Boolean

getCameraState

androidJvm

fun getCameraState(): CameraState

Get the current camera state.

getSize

androidJvm

fun getSize(): Size

Gets the size of the snapshot

getStyleJson

androidJvm

fun getStyleJson(): String

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

getStyleUri

androidJvm

fun getStyleUri(): String

Get the URI of the current Mapbox Style in use.

hashCode

androidJvm

open fun hashCode(): Int

isInTileMode

androidJvm

fun isInTileMode(): Boolean

Returns TRUE if the snapshotter is in the tile mode.

setCamera

androidJvm

fun setCamera(cameraOptions: CameraOptions)

Set the camera options of the snapshot.

setSize

androidJvm

fun setSize(size: Size)

Sets the size of the snapshot

setStyleJson

androidJvm

fun setStyleJson(styleJson: String)

Load the style from a provided JSON string.

setStyleListener

androidJvm

fun setStyleListener(listener: SnapshotStyleListener)

Set SnapshotStyleListener to listen to all events style related.

setStyleUri

androidJvm

fun setStyleUri(styleUri: String)

Set the URI of the current Mapbox Style in use.

setTileMode

androidJvm

fun setTileMode(set: Boolean)

Sets the snapshotter to the tile mode.

start

androidJvm

fun start(callback: SnapshotCreatedListener)

Start taking a snapshot.

androidJvm

fun subscribe(observer: Observer, events: List<String>)

Subscribes an Observer to a provided list of event types.

toString

androidJvm

open fun toString(): String

unsubscribe

androidJvm

fun unsubscribe(observer: Observer)

Unsubscribes an Observer from all events.

fun unsubscribe(observer: Observer, events: List<String>)

Unsubscribes an Observer from a provided list of event types.