mapbox-maps-android/com.mapbox.maps/MapSnapshotterInterface

MapSnapshotterInterface

interface MapSnapshotterInterface : CameraManagerInterface

MapSnapshotter exposes functionality to capture static map images.

Functions

addPersistentStyleCustomLayer

androidJvm

abstract fun addPersistentStyleCustomLayer(layerId: String, layerHost: CustomLayerHost, layerPosition: LayerPosition): Expected<String, None>

Adds a new [style custom layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).

addPersistentStyleLayer

androidJvm

@NonNull()

abstract fun addPersistentStyleLayer(properties: Value, layerPosition: LayerPosition): Expected<String, None>

Adds a new [style layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).

addStyleCustomGeometrySource

androidJvm

@NonNull()

abstract fun addStyleCustomGeometrySource(sourceId: String, options: CustomGeometrySourceOptions): Expected<String, None>

Adds a custom geometry to be used in the style.

addStyleCustomLayer

androidJvm

@NonNull()

abstract fun addStyleCustomLayer(layerId: String, layerHost: CustomLayerHost, layerPosition: LayerPosition): Expected<String, None>

Adds a new [style custom layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).

addStyleImage

androidJvm

@NonNull()

abstract fun addStyleImage(imageId: String, scale: Float, image: Image, sdf: Boolean, stretchX: List<ImageStretches>, stretchY: List<ImageStretches>, content: ImageContent): Expected<String, None>

Adds an image to be used in the style.

addStyleLayer

androidJvm

@NonNull()

abstract fun addStyleLayer(properties: Value, layerPosition: LayerPosition): Expected<String, None>

Adds a new [style layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).

addStyleSource

androidJvm

@NonNull()

abstract fun addStyleSource(sourceId: String, properties: Value): Expected<String, None>

Adds a new [style source](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources).

cameraForCoordinateBounds

androidJvm

@NonNull()

abstract fun cameraForCoordinateBounds(bounds: CoordinateBounds, padding: EdgeInsets, bearing: Double, pitch: Double): CameraOptions

Convenience method that returns the `camera options` object for given parameters.

cameraForCoordinates

androidJvm

@NonNull()

abstract fun cameraForCoordinates(coordinates: List<Point>, camera: CameraOptions, box: ScreenBox): CameraOptions

Convenience method that adjusts the provided `camera options` object for given parameters.

@NonNull()

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

Convenience method that returns the `camera options` object for given parameters.

cameraForGeometry

androidJvm

@NonNull()

abstract fun cameraForGeometry(geometry: Geometry, padding: EdgeInsets, bearing: Double, pitch: Double): CameraOptions

Convenience method that returns the `camera options` object for given parameters.

cancel

androidJvm

abstract fun cancel()

Cancel the current snapshot operation.

coordinateBoundsForCamera

androidJvm

@NonNull()

abstract fun coordinateBoundsForCamera(camera: CameraOptions): CoordinateBounds

Returns the `coordinate bounds` for a given camera.

coordinateBoundsForCameraUnwrapped

androidJvm

@NonNull()

abstract fun coordinateBoundsForCameraUnwrapped(camera: CameraOptions): CoordinateBounds

Returns the `coordinate bounds` for a given camera.

coordinateBoundsZoomForCamera

androidJvm

@NonNull()

abstract fun coordinateBoundsZoomForCamera(camera: CameraOptions): CoordinateBoundsZoom

Returns the `coordinate bounds` and the `zoom` for a given `camera`.

coordinateBoundsZoomForCameraUnwrapped

androidJvm

@NonNull()

abstract fun coordinateBoundsZoomForCameraUnwrapped(camera: CameraOptions): CoordinateBoundsZoom

Returns the unwrapped `coordinate bounds` and `zoom` for a given `camera`.

coordinateForPixel

androidJvm

@NonNull()

abstract fun coordinateForPixel(pixel: ScreenCoordinate): Point

Calculates a geographical `coordinate` (i.e., longitude-latitude pair) that corresponds to a `screen coordinate`.

coordinatesForPixels

androidJvm

@NonNull()

abstract fun coordinatesForPixels(pixels: List<ScreenCoordinate>): List<Point>

Calculates geographical `coordinates` (i.e., longitude-latitude pairs) that correspond to `screen coordinates`.

dragEnd

androidJvm

abstract fun dragEnd()

Ends the ongoing drag gesture.

dragStart

androidJvm

abstract fun dragStart(point: ScreenCoordinate)

Prepares the drag gesture to use the provided screen coordinate as a pivot `point`.

getBounds

androidJvm

@NonNull()

abstract fun getBounds(): CameraBounds

Returns the `camera bounds` of the map.

getCameraState

androidJvm

@NonNull()

abstract fun getCameraState(): CameraState

Returns the current `camera state`.

getDragCameraOptions

androidJvm

@NonNull()

abstract fun getDragCameraOptions(fromPoint: ScreenCoordinate, toPoint: ScreenCoordinate): CameraOptions

Calculates target point where camera should move after drag.

getElevation

androidJvm

@Nullable()

abstract fun getElevation(coordinate: Point): Double

Get elevation for the given coordinate.

getFreeCameraOptions

androidJvm

@NonNull()

abstract fun getFreeCameraOptions(): FreeCameraOptions

Gets the map's current free camera options.

getSize

androidJvm

@NonNull()

abstract fun getSize(): Size

Gets the size of the snapshot

getStyleDefaultCamera

androidJvm

@NonNull()

abstract fun getStyleDefaultCamera(): CameraOptions

Returns the map style's default camera, if any, or a default camera otherwise.

getStyleImage

androidJvm

@Nullable()

abstract fun getStyleImage(imageId: String): Image

Get an `image` from the style.

getStyleJSON

androidJvm

@NonNull()

abstract fun getStyleJSON(): String

Get the JSON serialization string of the current style in use.

getStyleLayerProperties

androidJvm

@NonNull()

abstract fun getStyleLayerProperties(layerId: String): Expected<String, Value>

Gets style layer properties.

getStyleLayerProperty

androidJvm

@NonNull()

abstract fun getStyleLayerProperty(layerId: String, property: String): StylePropertyValue

Gets the value of style layer property.

getStyleLayers

androidJvm

@NonNull()

abstract fun getStyleLayers(): List<StyleObjectInfo>

Returns the existing style layers.

getStyleLightProperty

androidJvm

@NonNull()

abstract fun getStyleLightProperty(property: String): StylePropertyValue

Gets the value of a style light property.

getStyleProjectionProperty

androidJvm

@NonNull()

abstract fun getStyleProjectionProperty(property: String): StylePropertyValue

Gets the value of a style projection property.

getStyleSourceProperties

androidJvm

@NonNull()

abstract fun getStyleSourceProperties(sourceId: String): Expected<String, Value>

Gets style source properties.

getStyleSourceProperty

androidJvm

@NonNull()

abstract fun getStyleSourceProperty(sourceId: String, property: String): StylePropertyValue

Gets the value of style source property.

getStyleSources

androidJvm

@NonNull()

abstract fun getStyleSources(): List<StyleObjectInfo>

Returns the existing style sources.

getStyleTerrainProperty

androidJvm

@NonNull()

abstract fun getStyleTerrainProperty(property: String): StylePropertyValue

Gets the value of a style terrain property.

getStyleTransition

androidJvm

@NonNull()

abstract fun getStyleTransition(): TransitionOptions

Returns the map style's transition options.

getStyleURI

androidJvm

@NonNull()

abstract fun getStyleURI(): String

Get the URI of the current style in use.

hasStyleImage

androidJvm

abstract fun hasStyleImage(imageId: String): Boolean

Checks whether an image exists.

invalidateStyleCustomGeometrySourceRegion

androidJvm

@NonNull()

abstract fun invalidateStyleCustomGeometrySourceRegion(sourceId: String, bounds: CoordinateBounds): Expected<String, None>

Invalidate region for provided custom geometry source.

invalidateStyleCustomGeometrySourceTile

androidJvm

@NonNull()

abstract fun invalidateStyleCustomGeometrySourceTile(sourceId: String, tileId: CanonicalTileID): Expected<String, None>

Invalidate tile for provided custom geometry source.

isInTileMode

androidJvm

abstract fun isInTileMode(): Boolean

Returns `true` if the snapshotter is in the tile mode.

isStyleLayerPersistent

androidJvm

@NonNull()

abstract fun isStyleLayerPersistent(layerId: String): Expected<String, Boolean>

Checks if a style layer is persistent.

isStyleLoaded

androidJvm

abstract fun isStyleLoaded(): Boolean

Check if the style is completely loaded.

moveStyleLayer

androidJvm

@NonNull()

abstract fun moveStyleLayer(layerId: String, layerPosition: LayerPosition): Expected<String, None>

Moves an existing style layer

pixelForCoordinate

androidJvm

@NonNull()

abstract fun pixelForCoordinate(coordinate: Point): ScreenCoordinate

Calculates a `screen coordinate` that corresponds to a geographical coordinate (i.e., longitude-latitude pair).

pixelsForCoordinates

androidJvm

@NonNull()

abstract fun pixelsForCoordinates(coordinates: List<Point>): List<ScreenCoordinate>

Calculates `screen coordinates` that correspond to geographical `coordinates` (i.e., longitude-latitude pairs).

removeStyleImage

androidJvm

@NonNull()

abstract fun removeStyleImage(imageId: String): Expected<String, None>

Removes an image from the style.

removeStyleLayer

androidJvm

@NonNull()

abstract fun removeStyleLayer(layerId: String): Expected<String, None>

Removes an existing style layer.

removeStyleSource

androidJvm

@NonNull()

abstract fun removeStyleSource(sourceId: String): Expected<String, None>

Removes an existing style source.

setBounds

androidJvm

@NonNull()

abstract fun setBounds(options: CameraBoundsOptions): Expected<String, None>

Sets the `camera bounds options` of the map.

setCamera

androidJvm

abstract fun setCamera(cameraOptions: CameraOptions)

Changes the map view by any combination of center, zoom, bearing, and pitch, without an animated transition.

abstract fun setCamera(freeCameraOptions: FreeCameraOptions)

Sets the map view with the free camera options.

setSize

androidJvm

abstract fun setSize(size: Size)

Sets the `size` of the snapshot

setStyleCustomGeometrySourceTileData

androidJvm

@NonNull()

abstract fun setStyleCustomGeometrySourceTileData(sourceId: String, tileId: CanonicalTileID, featureCollection: List<Feature>): Expected<String, None>

Set tile data of a custom geometry.

setStyleJSON

androidJvm

abstract fun setStyleJSON(json: String)

Load the style from a provided JSON string.

setStyleLayerProperties

androidJvm

@NonNull()

abstract fun setStyleLayerProperties(layerId: String, properties: Value): Expected<String, None>

Sets style layer properties.

setStyleLayerProperty

androidJvm

@NonNull()

abstract fun setStyleLayerProperty(layerId: String, property: String, value: Value): Expected<String, None>

Sets a value to a style layer property.

setStyleLight

androidJvm

@NonNull()

abstract fun setStyleLight(properties: Value): Expected<String, None>

Sets the style global [light](https://docs.mapbox.com/mapbox-gl-js/style-spec/#light) properties.

setStyleLightProperty

androidJvm

@NonNull()

abstract fun setStyleLightProperty(property: String, value: Value): Expected<String, None>

Sets a value to the the style light property.

setStyleProjection

androidJvm

@NonNull()

abstract fun setStyleProjection(properties: Value): Expected<String, None>

Sets the map's [projection](https://docs.mapbox.com/mapbox-gl-js/style-spec/projection/).

setStyleProjectionProperty

androidJvm

@NonNull()

abstract fun setStyleProjectionProperty(property: String, value: Value): Expected<String, None>

Sets a value to the the style projection property.

setStyleSourceProperties

androidJvm

@NonNull()

abstract fun setStyleSourceProperties(sourceId: String, properties: Value): Expected<String, None>

Sets style source properties.

setStyleSourceProperty

androidJvm

@NonNull()

abstract fun setStyleSourceProperty(sourceId: String, property: String, value: Value): Expected<String, None>

Sets a value to a style source property.

setStyleTerrain

androidJvm

@NonNull()

abstract fun setStyleTerrain(properties: Value): Expected<String, None>

Sets the style global [terrain](https://docs.mapbox.com/mapbox-gl-js/style-spec/#terrain) properties.

setStyleTerrainProperty

androidJvm

@NonNull()

abstract fun setStyleTerrainProperty(property: String, value: Value): Expected<String, None>

Sets a value to the the style terrain property.

setStyleTransition

androidJvm

abstract fun setStyleTransition(transitionOptions: TransitionOptions)

Overrides the map style's transition options with user-provided options.

setStyleURI

androidJvm

abstract fun setStyleURI(uri: String)

Load style from provided URI.

setTileMode

androidJvm

abstract fun setTileMode(set: Boolean)

Sets the snapshotter to the tile mode.

start

androidJvm

abstract fun start(callback: SnapshotCompleteCallback)

Start the rendering of a snapshot.

styleLayerExists

androidJvm

abstract fun styleLayerExists(layerId: String): Boolean

Checks whether a given style layer exists.

styleSourceExists

androidJvm

abstract fun styleSourceExists(sourceId: String): Boolean

Checks whether a given style source exists.

androidJvm

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

Subscribes an `observer` to a provided array of event types.

unsubscribe

androidJvm

abstract fun unsubscribe(observer: Observer)

Unsubscribes an `observer` from all events.

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

Unsubscribes an `observer` from a provided array of event types.

updateStyleImageSourceImage

androidJvm

@NonNull()

abstract fun updateStyleImageSourceImage(sourceId: String, image: Image): Expected<String, None>

Updates the image of an [image style source](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources-image).

Inheritors

MapSnapshotter