mapbox-maps-android/com.mapbox.maps/MapInterface

MapInterface

interface MapInterface : CameraManagerInterface

Map class provides map rendering functionality.

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

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

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

Adds a custom geometry to be used in the style.

addStyleCustomLayer

androidJvm

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

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

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

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

addViewAnnotation

androidJvm

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

cameraForCoordinateBounds

androidJvm

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

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

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

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

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

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

coordinateBoundsForCamera

androidJvm

abstract fun coordinateBoundsForCamera(camera: CameraOptions): CoordinateBounds

Returns the `coordinate bounds` for a given camera.

coordinateBoundsForCameraUnwrapped

androidJvm

abstract fun coordinateBoundsForCameraUnwrapped(camera: CameraOptions): CoordinateBounds

Returns the `coordinate bounds` for a given camera.

coordinateBoundsZoomForCamera

androidJvm

abstract fun coordinateBoundsZoomForCamera(camera: CameraOptions): CoordinateBoundsZoom

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

coordinateBoundsZoomForCameraUnwrapped

androidJvm

abstract fun coordinateBoundsZoomForCameraUnwrapped(camera: CameraOptions): CoordinateBoundsZoom

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

coordinateForPixel

androidJvm

abstract fun coordinateForPixel(pixel: ScreenCoordinate): Point

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

coordinatesForPixels

androidJvm

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

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

createRenderer

androidJvm

abstract fun createRenderer()

Creates the infrastructure needed for rendering the map.

destroyRenderer

androidJvm

abstract fun destroyRenderer()

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

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

abstract fun getBounds(): CameraBounds

Returns the `camera bounds` of the map.

getCameraState

androidJvm

abstract fun getCameraState(): CameraState

Returns the current `camera state`.

getDebug

androidJvm

abstract fun getDebug(): List<MapDebugOptions>

Returns the `map debug options`.

getDragCameraOptions

androidJvm

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

Calculates target point where camera should move after drag.

getElevation

androidJvm

abstract fun getElevation(coordinate: Point): Double

Gets elevation for the given coordinate.

getFeatureState

androidJvm

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

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

getFreeCameraOptions

androidJvm

abstract fun getFreeCameraOptions(): FreeCameraOptions

Gets the map's current free camera options.

getMapOptions

androidJvm

abstract fun getMapOptions(): MapOptions

Returns the `map options`.

getMapProjection

androidJvm

abstract fun getMapProjection(): Value

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

getPrefetchZoomDelta

androidJvm

abstract fun getPrefetchZoomDelta(): Byte

Returns the map's prefetch zoom delta.

getRenderCacheOptions

androidJvm

abstract fun getRenderCacheOptions(): RenderCacheOptions

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

getResourceOptions

androidJvm

abstract fun getResourceOptions(): ResourceOptions

Gets the resource options for the map.

getSize

androidJvm

abstract fun getSize(): Size

Gets the size of the map.

getStyleDefaultCamera

androidJvm

abstract fun getStyleDefaultCamera(): CameraOptions

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

getStyleImage

androidJvm

abstract fun getStyleImage(imageId: String): Image

Get an `image` from the style.

getStyleJSON

androidJvm

abstract fun getStyleJSON(): String

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

getStyleLayerProperties

androidJvm

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

Gets style layer properties.

getStyleLayerProperty

androidJvm

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

Gets the value of style layer property.

getStyleLayers

androidJvm

abstract fun getStyleLayers(): List<StyleObjectInfo>

Returns the existing style layers.

getStyleLightProperty

androidJvm

abstract fun getStyleLightProperty(property: String): StylePropertyValue

Gets the value of a style light property.

getStyleSourceProperties

androidJvm

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

Gets style source properties.

getStyleSourceProperty

androidJvm

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

Gets the value of style source property.

getStyleSources

androidJvm

abstract fun getStyleSources(): List<StyleObjectInfo>

Returns the existing style sources.

getStyleTerrainProperty

androidJvm

abstract fun getStyleTerrainProperty(property: String): StylePropertyValue

Gets the value of a style terrain property.

getStyleTransition

androidJvm

abstract fun getStyleTransition(): TransitionOptions

Returns the map style's transition options.

getStyleURI

androidJvm

abstract fun getStyleURI(): String

Get the URI of the current style in use.

getViewAnnotationOptions

androidJvm

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

hasStyleImage

androidJvm

abstract fun hasStyleImage(imageId: String): Boolean

Checks whether an image exists.

invalidateStyleCustomGeometrySourceRegion

androidJvm

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

Invalidate region for provided custom geometry source.

invalidateStyleCustomGeometrySourceTile

androidJvm

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

Invalidate tile for provided custom geometry source.

isGestureInProgress

androidJvm

abstract fun isGestureInProgress(): Boolean

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

isMapLoaded

androidJvm

abstract fun isMapLoaded(): Boolean

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

isStyleLayerPersistent

androidJvm

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.

isUserAnimationInProgress

androidJvm

abstract fun isUserAnimationInProgress(): Boolean

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

moveStyleLayer

androidJvm

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

Moves an existing style layer

pixelForCoordinate

androidJvm

abstract fun pixelForCoordinate(coordinate: Point): ScreenCoordinate

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

pixelsForCoordinates

androidJvm

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

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

queryFeatureExtensions

androidJvm

abstract 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

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

Queries the map for rendered features.

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

Queries the map for rendered features.

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

Queries the map for rendered features.

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

Queries the map for rendered features.

querySourceFeatures

androidJvm

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

Queries the map for source features.

reduceMemoryUse

androidJvm

abstract fun reduceMemoryUse()

Reduces memory use.

removeFeatureState

androidJvm

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

Removes entries from a feature state object.

removeStyleImage

androidJvm

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

Removes an image from the style.

removeStyleLayer

androidJvm

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

Removes an existing style layer.

removeStyleSource

androidJvm

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

Removes an existing style source.

removeViewAnnotation

androidJvm

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

render

androidJvm

abstract fun render()

Renders the map.

setBounds

androidJvm

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.

setConstrainMode

androidJvm

abstract fun setConstrainMode(mode: ConstrainMode)

Sets the map `constrain mode`.

setDebug

androidJvm

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

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

setFeatureState

androidJvm

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

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

setGestureInProgress

androidJvm

abstract fun setGestureInProgress(inProgress: Boolean)

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

setMapProjection

androidJvm

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

Updates the active map projection.

setMemoryBudget

androidJvm

abstract fun setMemoryBudget(memoryBudget: MapMemoryBudget)

setNorthOrientation

androidJvm

abstract fun setNorthOrientation(orientation: NorthOrientation)

Sets the north `orientation mode`.

setPrefetchZoomDelta

androidJvm

abstract 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

abstract fun setRenderCacheOptions(options: RenderCacheOptions)

Enables or disables the experimental render cache feature.

setSize

androidJvm

abstract fun setSize(size: Size)

Sets the size of the map.

setStyleCustomGeometrySourceTileData

androidJvm

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

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

Sets style layer properties.

setStyleLayerProperty

androidJvm

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

Sets a value to a style layer property.

setStyleLight

androidJvm

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

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

Sets a value to the the style light property.

setStyleSourceProperties

androidJvm

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

Sets style source properties.

setStyleSourceProperty

androidJvm

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

Sets a value to a style source property.

setStyleTerrain

androidJvm

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

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.

setUserAnimationInProgress

androidJvm

abstract fun setUserAnimationInProgress(inProgress: Boolean)

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

setViewAnnotationPositionsUpdateListener

androidJvm

abstract fun setViewAnnotationPositionsUpdateListener(listener: ViewAnnotationPositionsUpdateListener)

setViewportMode

androidJvm

abstract fun setViewportMode(mode: ViewportMode)

Sets the `viewport mode`.

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.

subscribe

androidJvm

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

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

triggerRepaint

androidJvm

abstract fun triggerRepaint()

Triggers a repaint of the map.

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

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

updateViewAnnotation

androidJvm

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

Inheritors

Map