MapSnapshotterInterface

interface MapSnapshotterInterface : CameraManagerInterface

MapSnapshotter exposes functionality to capture static map images.

Functions

addPersistentStyleCustomLayer

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

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

addPersistentStyleLayer

@NonNull

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

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

addStyleCustomGeometrySource

@NonNull

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

Adds a custom geometry to be used in the style.

addStyleCustomLayer

@NonNull

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

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

addStyleImage

@NonNull

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

Adds an image to be used in the style.

addStyleLayer

@NonNull

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

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

addStyleModel

@NonNull

abstract fun addStyleModel(@NonNull modelId: String, @NonNull modelUri: String): Expected<String, None>

Adds a model to be used in the style.

addStyleSource

@NonNull

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

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

cameraForCoordinateBounds

@NonNull

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

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

cameraForCoordinates

@NonNull

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

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

@NonNull

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

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

cameraForGeometry

@NonNull

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

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

cancel

abstract fun cancel()

Cancel the current snapshot operation.

coordinateBoundsForCamera

@NonNull

abstract fun coordinateBoundsForCamera(@NonNull camera: CameraOptions): CoordinateBounds

Returns the `coordinate bounds` for a given camera.

coordinateBoundsForCameraUnwrapped

@NonNull

abstract fun coordinateBoundsForCameraUnwrapped(@NonNull camera: CameraOptions): CoordinateBounds

Returns the `coordinate bounds` for a given camera.

coordinateBoundsZoomForCamera

@NonNull

abstract fun coordinateBoundsZoomForCamera(@NonNull camera: CameraOptions): CoordinateBoundsZoom

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

coordinateBoundsZoomForCameraUnwrapped

@NonNull

abstract fun coordinateBoundsZoomForCameraUnwrapped(@NonNull camera: CameraOptions): CoordinateBoundsZoom

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

coordinateForPixel

@NonNull

abstract fun coordinateForPixel(@NonNull pixel: ScreenCoordinate): Point

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

coordinatesForPixels

@NonNull

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

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

dragEnd

abstract fun dragEnd()

Ends the ongoing drag gesture.

dragStart

abstract fun dragStart(@NonNull point: ScreenCoordinate)

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

getBounds

@NonNull

abstract fun getBounds(): CameraBounds

Returns the `camera bounds` of the map.

getCameraState

@NonNull

abstract fun getCameraState(): CameraState

Returns the current `camera state`.

getDragCameraOptions

@NonNull

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

Calculates target point where camera should move after drag.

getElevation

@Nullable

abstract fun getElevation(@NonNull coordinate: Point): Double

Get elevation for the given coordinate.

getFreeCameraOptions

@NonNull

abstract fun getFreeCameraOptions(): FreeCameraOptions

Gets the map's current free camera options.

getSize

@NonNull

abstract fun getSize(): Size

Gets the size of the snapshot

getStyleAtmosphereProperty

@NonNull

abstract fun getStyleAtmosphereProperty(@NonNull property: String): StylePropertyValue

Gets the value of a style atmosphere property.

getStyleDefaultCamera

@NonNull

abstract fun getStyleDefaultCamera(): CameraOptions

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

getStyleImage

@Nullable

abstract fun getStyleImage(@NonNull imageId: String): Image

Get an `image` from the style.

getStyleJSON

@NonNull

abstract fun getStyleJSON(): String

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

getStyleLayerProperties

@NonNull

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

Gets style layer properties.

getStyleLayerProperty

@NonNull

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

Gets the value of style layer property.

getStyleLayers

@NonNull

abstract fun getStyleLayers(): List<StyleObjectInfo>

Returns the existing style layers.

getStyleLightProperty

@NonNull

abstract fun getStyleLightProperty(@NonNull property: String): StylePropertyValue

Gets the value of a style light property.

getStyleProjectionProperty

@NonNull

abstract fun getStyleProjectionProperty(@NonNull property: String): StylePropertyValue

Gets the value of a style projection property.

getStyleSourceProperties

@NonNull

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

Gets style source properties.

getStyleSourceProperty

@NonNull

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

Gets the value of style source property.

getStyleSources

@NonNull

abstract fun getStyleSources(): List<StyleObjectInfo>

Returns the existing style sources.

getStyleTerrainProperty

@NonNull

abstract fun getStyleTerrainProperty(@NonNull property: String): StylePropertyValue

Gets the value of a style terrain property.

getStyleTransition

@NonNull

abstract fun getStyleTransition(): TransitionOptions

Returns the map style's transition options.

getStyleURI

@NonNull

abstract fun getStyleURI(): String

Get the URI of the current style in use.

hasStyleImage

abstract fun hasStyleImage(@NonNull imageId: String): Boolean

Checks whether an image exists.

hasStyleModel

abstract fun hasStyleModel(@NonNull modelId: String): Boolean

Checks whether a model exists.

invalidateStyleCustomGeometrySourceRegion

@NonNull

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

Invalidate region for provided custom geometry source.

invalidateStyleCustomGeometrySourceTile

@NonNull

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

Invalidate tile for provided custom geometry source.

isInTileMode

abstract fun isInTileMode(): Boolean

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

isStyleLayerPersistent

@NonNull

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

Checks if a style layer is persistent.

isStyleLoaded

abstract fun isStyleLoaded(): Boolean

Check if the style is completely loaded.

moveStyleLayer

@NonNull

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

Moves an existing style layer

pixelForCoordinate

@NonNull

abstract fun pixelForCoordinate(@NonNull coordinate: Point): ScreenCoordinate

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

pixelsForCoordinates

@NonNull

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

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

removeStyleImage

@NonNull

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

Removes an image from the style.

removeStyleLayer

@NonNull

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

Removes an existing style layer.

removeStyleModel

@NonNull

abstract fun removeStyleModel(@NonNull modelId: String): Expected<String, None>

Removes a model from the style.

removeStyleSource

@NonNull

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

Removes an existing style source.

setBounds

@NonNull

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

Sets the `camera bounds options` of the map.

setCamera

abstract fun setCamera(@NonNull cameraOptions: CameraOptions)

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

abstract fun setCamera(@NonNull freeCameraOptions: FreeCameraOptions)

Sets the map view with the free camera options.

setSize

abstract fun setSize(@NonNull size: Size)

Sets the `size` of the snapshot

setStyleAtmosphere

@NonNull

abstract fun setStyleAtmosphere(@NonNull properties: Value): Expected<String, None>

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

setStyleAtmosphereProperty

@NonNull

abstract fun setStyleAtmosphereProperty(@NonNull property: String, @NonNull value: Value): Expected<String, None>

Sets a value to the the style atmosphere property.

setStyleCustomGeometrySourceTileData

@NonNull

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

Set tile data of a custom geometry.

setStyleJSON

abstract fun setStyleJSON(@NonNull json: String)

Load the style from a provided JSON string.

setStyleLayerProperties

@NonNull

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

Sets style layer properties.

setStyleLayerProperty

@NonNull

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

Sets a value to a style layer property.

setStyleLight

@NonNull

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

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

setStyleLightProperty

@NonNull

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

Sets a value to the the style light property.

setStyleProjection

@NonNull

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

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

setStyleProjectionProperty

@NonNull

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

Sets a value to the the style projection property.

setStyleSourceProperties

@NonNull

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

Sets style source properties.

setStyleSourceProperty

@NonNull

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

Sets a value to a style source property.

setStyleTerrain

@NonNull

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

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

setStyleTerrainProperty

@NonNull

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

Sets a value to the the style terrain property.

setStyleTransition

abstract fun setStyleTransition(@NonNull transitionOptions: TransitionOptions)

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

setStyleURI

abstract fun setStyleURI(@NonNull uri: String)

Load style from provided URI.

setTileMode

abstract fun setTileMode(set: Boolean)

Sets the snapshotter to the tile mode.

start

abstract fun start(@NonNull callback: SnapshotCompleteCallback)

Start the rendering of a snapshot.

styleLayerExists

abstract fun styleLayerExists(@NonNull layerId: String): Boolean

Checks whether a given style layer exists.

styleSourceExists

abstract fun styleSourceExists(@NonNull sourceId: String): Boolean

Checks whether a given style source exists.

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

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

unsubscribe

abstract fun unsubscribe(@NonNull observer: Observer)

Unsubscribes an `observer` from all events.

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

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

updateStyleImageSourceImage

@NonNull

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

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