Mapbox Maps Android/com.mapbox.maps/Snapshotter

Snapshotter

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

class Snapshotter : MapSnapshotterObserver

Constructors

Snapshotter

fun Snapshotter(context: Context, options: MapSnapshotOptions)

Types

Companion

Static variables and methods.

object Companion

SnapshotReadyCallback

Callback for getting snapshot when it's finished.

interface SnapshotReadyCallback

Functions

cameraForCoordinates

Convenience method that returns the camera options object for given arguments

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

cancel

Cancel taking snapshot if it was running.

fun cancel()

equals

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

finalize

open override fun finalize()

getCameraOptions

Get the current camera options

fun getCameraOptions(): CameraOptions

getJson

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

fun getJson(): String

getRegion

Get the previously set rectangular bounds.

fun getRegion(): CoordinateBounds

getSize

Gets the size of the snapshot

fun getSize(): Size

getUri

Get the URI of the current Mapbox Style in use.

fun getUri(): String

hashCode

open override fun hashCode(): Int

isInTileMode

Returns TRUE if the snapshotter is in the tile mode.

fun isInTileMode(): Boolean

onDidFailLoadingStyle

Notifies the client about style load errors

open override fun onDidFailLoadingStyle(message: String)

onDidFinishLoadingStyle

Notifies the client when style loading finished.

open override fun onDidFinishLoadingStyle()

onStyleImageMissing

Notifies the client about a missing style image.

open override fun onStyleImageMissing(imageId: String)

setCameraOptions

Set the camera options of the snapshot.

fun setCameraOptions(cameraOptions: CameraOptions)

setJson

Load the style from a provided JSON string.

This method should be called on the same thread where @see Map object is initialized.

fun setJson(styleJson: String)

setSize

Sets the size of the snapshot

fun setSize(size: Size)

setTileMode

Sets the snapshotter to the tile mode.

In the tile mode, the snapshotter fetches the still image of a single tile.

fun setTileMode(set: Boolean)

setUri

Set the URI of the current Mapbox Style in use.

fun setUri(uri: String)

start

Start taking a snapshot.

fun start(callback: Snapshotter.SnapshotReadyCallback)

Subscribes an Observer to a provided list of event types. Observable will hold a strong reference to an Observer instance, therefore, in order to stop receiving notifications, caller must call unsubscribe with an Observer instance used for an initial subscription.

fun subscribe(observer: Observer, list: MutableList<String>)

toString

open override fun toString(): String

unsubscribe

Unsubscribes an Observer from all events.

fun unsubscribe(observer: Observer)

Unsubscribes an Observer from a provided list of event types.

fun unsubscribe(observer: Observer, list: MutableList<String>)

Properties

peer

override val peer: Long