Camera Manager

open 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

addStyleCustomGeometrySource

open 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).

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

Adds a custom geometry to be used in the style.

addStyleCustomLayer

addStyleCustomRasterSource

open 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).

open fun addStyleCustomRasterSource(@NonNull sourceId: String, @NonNull options: CustomRasterSourceOptions): Expected<String, None>

Note!

addStyleImage

open 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

open 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

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

Adds a model to be used in the style.

addStyleSource

cameraForCoordinateBounds

open 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).

open fun cameraForCoordinateBounds(@NonNull bounds: CoordinateBounds, @Nullable padding: EdgeInsets, @Nullable bearing: Double, @Nullable pitch: Double, @Nullable maxZoom: Double, @Nullable offset: ScreenCoordinate): CameraOptions

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

cameraForCoordinates

open 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.

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

open fun cameraForCoordinates(@NonNull coordinates: List<Point>, @Nullable camera: CameraOptions, @Nullable coordinatesPadding: EdgeInsets, @Nullable maxZoom: Double, @Nullable offset: ScreenCoordinate): Expected<String, CameraOptions>

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

cameraForDrag

open fun cameraForDrag(@NonNull startCoordinate: ScreenCoordinate, @NonNull endCoordinate: ScreenCoordinate): CameraOptions

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

cameraForGeometry

coordinateBoundsForCamera

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

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

coordinateBoundsForCameraUnwrapped

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

Returns the `coordinate bounds` for a given camera.

coordinateBoundsZoomForCamera

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

Returns the `coordinate bounds` for a given camera.

coordinateBoundsZoomForCameraUnwrapped

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

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

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

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

coordinateForPixel

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

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

coordinateInfoForPixel

open fun coordinateInfoForPixel(@NonNull pixel: ScreenCoordinate): CoordinateInfo

Calculates the geographical coordinate information that corresponds to a given screen coordinate.

coordinatesForPixels

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

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

coordinatesInfoForPixels

open fun coordinatesInfoForPixels(@NonNull pixels: List<ScreenCoordinate>): List<CoordinateInfo>

Calculates the geographical coordinates information that corresponds to the given screen coordinates.

getBounds

open fun getBounds(): CameraBounds

Returns the `camera bounds` of the map.

getCameraState

open fun getCameraState(): CameraState

Returns the current `camera state`.

getFreeCameraOptions

open fun getFreeCameraOptions(): FreeCameraOptions

Gets the map's current free camera options.

getRenderWorldCopies

getStyleAtmosphereProperty

open fun getRenderWorldCopies(): Boolean

Returns whether multiple copies of the world are being rendered side by side beyond -180 and 180 degrees longitude.

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

Gets the value of a style atmosphere property.

getStyleDefaultCamera

open fun getStyleDefaultCamera(): CameraOptions

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

getStyleImage

@Nullable

getStyleImportConfigProperties

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

Get an `image` from the style.

getStyleImportConfigProperty

open fun getStyleImportConfigProperties(@NonNull importId: String): Expected<String, HashMap<String, StylePropertyValue>>

Gets style import config.

open fun getStyleImportConfigProperty(@NonNull importId: String, @NonNull config: String): Expected<String, StylePropertyValue>

Gets the value of style import config.

getStyleImports

open fun getStyleImports(): List<StyleObjectInfo>

Returns the existing style imports.

getStyleImportSchema

open fun getStyleImportSchema(@NonNull importId: String): Expected<String, Value>

Gets style import schema.

getStyleJSON

open fun getStyleJSON(): String

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

getStyleLayerProperties

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

Gets style layer properties.

getStyleLayerProperty

getStyleLayerPropertyDefaultValue

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

Gets the value of style layer property.

open fun getStyleLayerPropertyDefaultValue(@NonNull layerType: String, @NonNull property: String): StylePropertyValue

Gets the default value of style layer property

getStyleLayers

open fun getStyleLayers(): List<StyleObjectInfo>

Returns the existing style layers.

getStyleLightProperty

open fun getStyleLightProperty(@NonNull id: String, @NonNull property: String): StylePropertyValue

getStyleLights

getStyleProjectionProperty

open fun getStyleLights(): List<StyleObjectInfo>

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

Gets the value of a style projection property.

getStyleSourceProperties

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

Gets style source properties.

getStyleSourceProperty

getStyleSourcePropertyDefaultValue

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

Gets the value of style source property.

open fun getStyleSourcePropertyDefaultValue(@NonNull sourceType: String, @NonNull property: String): StylePropertyValue

Gets the default value of style source property.

getStyleSources

open fun getStyleSources(): List<StyleObjectInfo>

Returns the existing style sources.

getStyleTerrainProperty

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

Gets the value of a style terrain property.

getStyleTransition

open fun getStyleTransition(): TransitionOptions

Returns the map style's transition options.

getStyleURI

open fun getStyleURI(): String

Get the URI of the current style in use.

hasStyleImage

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

Checks whether an image exists.

hasStyleModel

invalidateStyleCustomGeometrySourceRegion

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

Checks whether a model exists.

invalidateStyleCustomGeometrySourceTile

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

Invalidate region for provided custom geometry source.

invalidateStyleCustomRasterSourceRegion

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

Invalidate tile for provided custom geometry source.

invalidateStyleCustomRasterSourceTile

open fun invalidateStyleCustomRasterSourceRegion(@NonNull sourceId: String, @NonNull bounds: CoordinateBounds): Expected<String, None>

Note!

open fun invalidateStyleCustomRasterSourceTile(@NonNull sourceId: String, @NonNull tileId: CanonicalTileID): Expected<String, None>

Note!

isStyleLayerPersistent

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

Checks if a style layer is persistent.

isStyleLoaded

open fun isStyleLoaded(): Boolean

Check if the style is completely loaded.

moveStyleLayer

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

Moves an existing style layer

pixelForCoordinate

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

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

pixelsForCoordinates

removeGeoJSONSourceFeatures

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

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

open fun removeGeoJSONSourceFeatures(@NonNull sourceId: String, @NonNull dataId: String, @NonNull featureIds: List<String>): Expected<String, None>

Remove features from a GeoJSON style source.

removeStyleImage

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

Removes an image from the style.

removeStyleImport

open fun removeStyleImport(@NonNull importId: String): Expected<String, None>

Removes an existing style import.

removeStyleLayer

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

Removes an existing style layer.

removeStyleModel

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

Removes a model from the style.

removeStyleSource

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

Removes an existing style source.

setBounds

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

Sets the `camera bounds options` of the map.

setCamera

open fun setCamera(@NonNull cameraOptions: CameraOptions)

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

open fun setCamera(@NonNull freeCameraOptions: FreeCameraOptions)

Sets the map view with the free camera options.

setRenderWorldCopies

open fun setRenderWorldCopies(renderWorldCopies: Boolean)

Sets whether multiple copies of the world will be rendered side by side beyond -180 and 180 degrees longitude.

setStyleAtmosphere

setStyleAtmosphereProperty

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

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

setStyleCustomGeometrySourceTileData

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

Sets a value to the the style atmosphere property.

setStyleCustomRasterSourceTileData

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

Set tile data of a custom geometry.

setStyleGeoJSONSourceData

open fun setStyleCustomRasterSourceTileData(@NonNull sourceId: String, @NonNull tileId: CanonicalTileID, @Nullable image: Image): Expected<String, None>

Note!

setStyleImportConfigProperties

open fun setStyleGeoJSONSourceData(@NonNull sourceId: String, @NonNull dataId: String, @NonNull data: GeoJSONSourceData): Expected<String, None>

setStyleImportConfigProperty

open fun setStyleImportConfigProperties(@NonNull importId: String, @NonNull configs: HashMap<String, Value>): Expected<String, None>

Sets style import config.

open fun setStyleImportConfigProperty(@NonNull importId: String, @NonNull config: String, @NonNull value: Value): Expected<String, None>

Sets a value to a style import config.

setStyleJSON

open fun setStyleJSON(@NonNull json: String)

open fun setStyleJSON(@NonNull json: String, @NonNull stylingOptions: RuntimeStylingOptions)

Load the style from a provided JSON string.

setStyleLayerProperties

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

Sets style layer properties.

setStyleLayerProperty

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

Sets a value to a style layer property.

setStyleLightProperty

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

setStyleLights

open fun setStyleLights(@NonNull lights: Value): Expected<String, None>

setStyleProjection

setStyleProjectionProperty

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

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

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

Sets a value to the the style projection property.

setStyleSourceProperties

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

Sets style source properties.

setStyleSourceProperty

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

Sets a value to a style source property.

setStyleTerrain

open 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

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

Sets a value to the the style terrain property.

setStyleTransition

open fun setStyleTransition(@NonNull transitionOptions: TransitionOptions)

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

setStyleURI

open fun setStyleURI(@NonNull uri: String)

open fun setStyleURI(@NonNull uri: String, @NonNull stylingOptions: RuntimeStylingOptions)

Load style from provided URI.

styleLayerExists

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

Checks whether a given style layer exists.

styleSourceExists

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

Checks whether a given style source exists.

open fun subscribe(@NonNull cameraChanged: CameraChangedCallback): Cancelable

Subscribes to `CameraChanged` event.

open fun subscribe(@NonNull mapIdle: MapIdleCallback): Cancelable

Subscribes to `MapIdle` event.

open fun subscribe(@NonNull mapLoaded: MapLoadedCallback): Cancelable

Subscribes to `MapLoaded` event.

open fun subscribe(@NonNull mapLoadingError: MapLoadingErrorCallback): Cancelable

Subscribes to `MapLoadingError` event.

open fun subscribe(@NonNull perfStatsCollected: PerfStatsCollectedCallback): Cancelable

Subscribes to `PerfStatsCollected` event.

open fun subscribe(@NonNull renderFrameFinished: RenderFrameFinishedCallback): Cancelable

Subscribes to `RenderFrameFinished` event.

open fun subscribe(@NonNull renderFrameStarted: RenderFrameStartedCallback): Cancelable

Subscribes to `RenderFrameStarted` event.

open fun subscribe(@NonNull resourceRequest: ResourceRequestCallback): Cancelable

Subscribes to `ResourceRequest` event.

open fun subscribe(@NonNull sourceAdded: SourceAddedCallback): Cancelable

Subscribes to `SourceAdded` event.

open fun subscribe(@NonNull sourceDataLoaded: SourceDataLoadedCallback): Cancelable

Subscribes to `SourceDataLoaded` event.

open fun subscribe(@NonNull sourceRemoved: SourceRemovedCallback): Cancelable

Subscribes to `SourceRemoved` event.

open fun subscribe(@NonNull styleDataLoaded: StyleDataLoadedCallback): Cancelable

Subscribes to `StyleDataLoaded` event.

open fun subscribe(@NonNull styleImageMissing: StyleImageMissingCallback): Cancelable

Subscribes to `StyleImageMissing` event.

open fun subscribe(@NonNull styleImageRemoveUnused: StyleImageRemoveUnusedCallback): Cancelable

Subscribes to `StyleImageRemoveUnused` event.

open fun subscribe(@NonNull styleLoaded: StyleLoadedCallback): Cancelable

Subscribes to `StyleLoaded` event.

open fun subscribe(@NonNull eventName: String, @NonNull callback: GenericEventCallback): Cancelable

Subscribes to an experimental `GenericEvent` event.

tileCover

updateGeoJSONSourceFeatures

open fun tileCover(@NonNull tileCoverOptions: TileCoverOptions, @Nullable cameraOptions: CameraOptions): List<CanonicalTileID>

updateStyleImageSourceImage

open fun updateGeoJSONSourceFeatures(@NonNull sourceId: String, @NonNull dataId: String, @NonNull features: List<Feature>): Expected<String, None>

Update existing features in a GeoJSON style source.