Snapshotter

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

Constructors

Snapshotter

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.

clearData

fun clearData(callback: AsyncOperationResultCallback)

Clears temporary map data.

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.

isInTileMode

~~fun~~ ~~isInTileMode~~(): Boolean

Returns TRUE if the snapshotter is in the tile mode.

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.

setTileMode

~~fun~~ ~~setTileMode~~(~~set~~: Boolean)

Sets the snapshotter to the tile mode.

start

fun start(callback: SnapshotCreatedListener)

Start taking a snapshot.

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

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.

tileCover

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

Returns tileIDs that cover current map camera

unsubscribe

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.