Mapbox Maps Android/com.mapbox.maps/Snapshotter

Snapshotter

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

open class Snapshotter

Constructors

Snapshotter

fun Snapshotter(context: Context, options: MapSnapshotOptions)

Types

Companion

Static variables and methods.

object Companion

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()

coordinateBoundsForCamera

Returns the coordinate bounds for a given camera.

Note that if the given camera shows the antimeridian, the returned wrapped bounds might not represent the minimum bounding box.

fun coordinateBoundsForCamera(options: CameraOptions): CoordinateBounds

equals

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

getCameraState

Get the current camera state.

fun getCameraState(): CameraState

getSize

Gets the size of the snapshot

fun getSize(): Size

getStyleJson

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

fun getStyleJson(): String

getStyleUri

Get the URI of the current Mapbox Style in use.

fun getStyleUri(): String

hashCode

open override fun hashCode(): Int

isInTileMode

Returns TRUE if the snapshotter is in the tile mode.

fun isInTileMode(): Boolean

setCamera

Set the camera options of the snapshot.

fun setCamera(cameraOptions: CameraOptions)

setSize

Sets the size of the snapshot

fun setSize(size: Size)

setStyleJson

Load the style from a provided JSON string.

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

fun setStyleJson(styleJson: String)

setStyleListener

Set SnapshotStyleListener to listen to all events style related.

fun setStyleListener(listener: SnapshotStyleListener)

setStyleUri

Set the URI of the current Mapbox Style in use.

fun setStyleUri(styleUri: String)

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)

start

Start taking a snapshot.

fun start(callback: SnapshotCreatedListener)

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, events: 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, events: MutableList<String>)