mapbox-maps-android/com.mapbox.maps/Map

Map

class Map : CameraManager, MapInterface

Map class provides map rendering functionality.

Constructors

Map

androidJvm

open fun Map(client: MapClient, mapOptions: MapOptions, resourceOptions: ResourceOptions)

Initializes the map object.

Functions

addPersistentStyleCustomLayer

androidJvm

open 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

open 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

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

Adds a custom geometry to be used in the style.

addStyleCustomLayer

androidJvm

open 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

open 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

open 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

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

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

addViewAnnotation

androidJvm

open fun addViewAnnotation(identifier: String, options: ViewAnnotationOptions): Expected<String, None>

cameraForCoordinateBounds

androidJvm

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

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

cameraForCoordinates

androidJvm

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

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

open 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

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

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

clearData

androidJvm

open fun clearData(resourceOptions: ResourceOptions, callback: AsyncOperationResultCallback)

Clears temporary map data.

coordinateBoundsForCamera

androidJvm

open fun coordinateBoundsForCamera(camera: CameraOptions): CoordinateBounds

Returns the `coordinate bounds` for a given camera.

coordinateBoundsForCameraUnwrapped

androidJvm

open fun coordinateBoundsForCameraUnwrapped(camera: CameraOptions): CoordinateBounds

Returns the `coordinate bounds` for a given camera.

coordinateBoundsZoomForCamera

androidJvm

open fun coordinateBoundsZoomForCamera(camera: CameraOptions): CoordinateBoundsZoom

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

coordinateBoundsZoomForCameraUnwrapped

androidJvm

open fun coordinateBoundsZoomForCameraUnwrapped(camera: CameraOptions): CoordinateBoundsZoom

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

coordinateForPixel

androidJvm

open fun coordinateForPixel(pixel: ScreenCoordinate): Point

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

coordinatesForPixels

androidJvm

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

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

createRenderer

androidJvm

open fun createRenderer()

Creates the infrastructure needed for rendering the map.

destroyRenderer

androidJvm

open fun destroyRenderer()

Destroys the infrastructure needed for rendering the map, releasing resources.

dragEnd

androidJvm

open fun dragEnd()

Ends the ongoing drag gesture.

dragStart

androidJvm

open fun dragStart(point: ScreenCoordinate)

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

getBounds

androidJvm

open fun getBounds(): CameraBounds

Returns the `camera bounds` of the map.

getCameraState

androidJvm

open fun getCameraState(): CameraState

Returns the current `camera state`.

getDebug

androidJvm

open fun getDebug(): List<MapDebugOptions>

Returns the `map debug options`.

getDragCameraOptions

androidJvm

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

Calculates target point where camera should move after drag.

getElevation

androidJvm

open fun getElevation(coordinate: Point): Double

Gets elevation for the given coordinate.

getFeatureState

androidJvm

open fun getFeatureState(sourceId: String, sourceLayerId: String, featureId: String, callback: QueryFeatureStateCallback)

Gets the state map of a feature within a style source.

getFreeCameraOptions

androidJvm

open fun getFreeCameraOptions(): FreeCameraOptions

Gets the map's current free camera options.

getMapOptions

androidJvm

open fun getMapOptions(): MapOptions

Returns the `map options`.

getMapProjection

androidJvm

open fun getMapProjection(): Value

Returns the currently active map projection and its properties as key-value pairs.

getNativePtr

androidJvm

open fun getNativePtr(): Long

Experimental feature.

getPrefetchZoomDelta

androidJvm

open fun getPrefetchZoomDelta(): Byte

Returns the map's prefetch zoom delta.

getRenderCacheOptions

androidJvm

open fun getRenderCacheOptions(): RenderCacheOptions

Returns the `render cache options` used by the map.

getResourceOptions

androidJvm

open fun getResourceOptions(): ResourceOptions

Gets the resource options for the map.

getSize

androidJvm

open fun getSize(): Size

Gets the size of the map.

getStyleDefaultCamera

androidJvm

open fun getStyleDefaultCamera(): CameraOptions

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

getStyleImage

androidJvm

open fun getStyleImage(imageId: String): Image

Get an `image` from the style.

getStyleJSON

androidJvm

open fun getStyleJSON(): String

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

getStyleLayerProperties

androidJvm

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

Gets style layer properties.

getStyleLayerProperty

androidJvm

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

Gets the value of style layer property.

getStyleLayerPropertyDefaultValue

androidJvm

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

Gets the default value of style layer property

getStyleLayers

androidJvm

open fun getStyleLayers(): List<StyleObjectInfo>

Returns the existing style layers.

getStyleLightProperty

androidJvm

open fun getStyleLightProperty(property: String): StylePropertyValue

Gets the value of a style light property.

getStyleSourceProperties

androidJvm

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

Gets style source properties.

getStyleSourceProperty

androidJvm

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

Gets the value of style source property.

getStyleSourcePropertyDefaultValue

androidJvm

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

Gets the default value of style source property.

getStyleSources

androidJvm

open fun getStyleSources(): List<StyleObjectInfo>

Returns the existing style sources.

getStyleTerrainProperty

androidJvm

open fun getStyleTerrainProperty(property: String): StylePropertyValue

Gets the value of a style terrain property.

getStyleTransition

androidJvm

open fun getStyleTransition(): TransitionOptions

Returns the map style's transition options.

getStyleURI

androidJvm

open fun getStyleURI(): String

Get the URI of the current style in use.

getViewAnnotationOptions

androidJvm

open fun getViewAnnotationOptions(identifier: String): Expected<String, ViewAnnotationOptions>

hasStyleImage

androidJvm

open fun hasStyleImage(imageId: String): Boolean

Checks whether an image exists.

invalidateStyleCustomGeometrySourceRegion

androidJvm

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

Invalidate region for provided custom geometry source.

invalidateStyleCustomGeometrySourceTile

androidJvm

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

Invalidate tile for provided custom geometry source.

isGestureInProgress

androidJvm

open fun isGestureInProgress(): Boolean

Returns `true` if a gesture is currently in progress.

isMapLoaded

androidJvm

open fun isMapLoaded(): Boolean

Returns `true` when the map is completely rendered, `false` otherwise.

isStyleLayerPersistent

androidJvm

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

Checks if a style layer is persistent.

isStyleLoaded

androidJvm

open fun isStyleLoaded(): Boolean

Check if the style is completely loaded.

isUserAnimationInProgress

androidJvm

open fun isUserAnimationInProgress(): Boolean

Returns `true` if user animation is currently in progress.

moveStyleLayer

androidJvm

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

Moves an existing style layer

pixelForCoordinate

androidJvm

open fun pixelForCoordinate(coordinate: Point): ScreenCoordinate

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

pixelsForCoordinates

androidJvm

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

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

queryFeatureExtensions

androidJvm

open fun queryFeatureExtensions(sourceIdentifier: String, feature: Feature, extension: String, extensionField: String, args: HashMap<String, Value>, callback: QueryFeatureExtensionCallback)

Queries for feature extension values in a GeoJSON source.

queryRenderedFeatures

androidJvm

open fun queryRenderedFeatures(geometry: RenderedQueryGeometry, options: RenderedQueryOptions, callback: QueryFeaturesCallback): Cancelable

Queries the map for rendered features.

open fun queryRenderedFeatures(box: ScreenBox, options: RenderedQueryOptions, callback: QueryFeaturesCallback)

Queries the map for rendered features.

open fun queryRenderedFeatures(pixel: ScreenCoordinate, options: RenderedQueryOptions, callback: QueryFeaturesCallback)

Queries the map for rendered features.

open fun queryRenderedFeatures(shape: List<ScreenCoordinate>, options: RenderedQueryOptions, callback: QueryFeaturesCallback)

Queries the map for rendered features.

querySourceFeatures

androidJvm

open fun querySourceFeatures(sourceId: String, options: SourceQueryOptions, callback: QueryFeaturesCallback)

Queries the map for source features.

reduceMemoryUse

androidJvm

open fun reduceMemoryUse()

Reduces memory use.

removeFeatureState

androidJvm

open fun removeFeatureState(sourceId: String, sourceLayerId: String, featureId: String, stateKey: String)

Removes entries from a feature state object.

removeStyleImage

androidJvm

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

Removes an image from the style.

removeStyleLayer

androidJvm

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

Removes an existing style layer.

removeStyleSource

androidJvm

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

Removes an existing style source.

removeViewAnnotation

androidJvm

open fun removeViewAnnotation(identifier: String): Expected<String, None>

render

androidJvm

open fun render()

Renders the map.

setBounds

androidJvm

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

Sets the `camera bounds options` of the map.

setCamera

androidJvm

open fun setCamera(cameraOptions: CameraOptions)

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

open fun setCamera(freeCameraOptions: FreeCameraOptions)

Sets the map view with the free camera options.

setConstrainMode

androidJvm

open fun setConstrainMode(mode: ConstrainMode)

Sets the map `constrain mode`.

setDebug

androidJvm

open fun setDebug(debugOptions: List<MapDebugOptions>, value: Boolean)

Sets the `map debug options` and enables debug mode based on the passed value.

setFeatureState

androidJvm

open fun setFeatureState(sourceId: String, sourceLayerId: String, featureId: String, state: Value)

Updates the state object of a feature within a style source.

setGestureInProgress

androidJvm

open fun setGestureInProgress(inProgress: Boolean)

Tells the map rendering engine that there is currently a gesture in progress.

setMapProjection

androidJvm

open fun setMapProjection(projection: Value): Expected<String, None>

Updates the active map projection.

setMemoryBudget

androidJvm

open fun setMemoryBudget(memoryBudget: MapMemoryBudget)

setNorthOrientation

androidJvm

open fun setNorthOrientation(orientation: NorthOrientation)

Sets the north `orientation mode`.

setPrefetchZoomDelta

androidJvm

open fun setPrefetchZoomDelta(delta: Byte)

When loading a map, if prefetch zoom `delta` is set to any number greater than 0, the map will first request a tile at zoom level lower than `zoom - delta`, with requested zoom level a multiple of `delta`, in an attempt to display a full map at lower resolution as quick as possible.

setRenderCacheOptions

androidJvm

open fun setRenderCacheOptions(options: RenderCacheOptions)

Enables or disables the experimental render cache feature.

setSize

androidJvm

open fun setSize(size: Size)

Sets the size of the map.

setStyleCustomGeometrySourceTileData

androidJvm

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

Set tile data of a custom geometry.

setStyleJSON

androidJvm

open fun setStyleJSON(json: String)

Load the style from a provided JSON string.

setStyleLayerProperties

androidJvm

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

Sets style layer properties.

setStyleLayerProperty

androidJvm

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

Sets a value to a style layer property.

setStyleLight

androidJvm

open 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

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

Sets a value to the the style light property.

setStyleSourceProperties

androidJvm

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

Sets style source properties.

setStyleSourceProperty

androidJvm

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

Sets a value to a style source property.

setStyleTerrain

androidJvm

open 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

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

Sets a value to the the style terrain property.

setStyleTransition

androidJvm

open fun setStyleTransition(transitionOptions: TransitionOptions)

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

setStyleURI

androidJvm

open fun setStyleURI(uri: String)

Load style from provided URI.

setUserAnimationInProgress

androidJvm

open fun setUserAnimationInProgress(inProgress: Boolean)

Tells the map rendering engine that the animation is currently performed by the user (e.g.

setViewAnnotationPositionsUpdateListener

androidJvm

open fun setViewAnnotationPositionsUpdateListener(listener: ViewAnnotationPositionsUpdateListener)

setViewportMode

androidJvm

open fun setViewportMode(mode: ViewportMode)

Sets the `viewport mode`.

styleLayerExists

androidJvm

open fun styleLayerExists(layerId: String): Boolean

Checks whether a given style layer exists.

styleSourceExists

androidJvm

open fun styleSourceExists(sourceId: String): Boolean

Checks whether a given style source exists.

subscribe

androidJvm

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

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

triggerRepaint

androidJvm

open fun triggerRepaint()

Triggers a repaint of the map.

unsubscribe

androidJvm

open fun unsubscribe(observer: Observer)

Unsubscribes an `observer` from all events.

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

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

updateStyleImageSourceImage

androidJvm

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

updateViewAnnotation

androidJvm

open fun updateViewAnnotation(identifier: String, options: ViewAnnotationOptions): Expected<String, None>