MapInterface

interface MapInterface : CameraManagerInterface
Content copied to clipboard

Map class provides map rendering functionality.

Functions

addPersistentStyleCustomLayer
Link copied to clipboard
@NonNull
abstract fun addPersistentStyleCustomLayer(@NonNull layerId: String, @NonNull layerHost: CustomLayerHost, @Nullable layerPosition: LayerPosition): Expected<String, None>
Content copied to clipboard
Adds a new [style custom layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).
addPersistentStyleLayer
Link copied to clipboard
@NonNull
abstract fun addPersistentStyleLayer(@NonNull properties: Value, @Nullable layerPosition: LayerPosition): Expected<String, None>
Content copied to clipboard
Adds a new [style layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).
addStyleCustomGeometrySource
Link copied to clipboard
@NonNull
abstract fun addStyleCustomGeometrySource(@NonNull sourceId: String, @NonNull options: CustomGeometrySourceOptions): Expected<String, None>
Content copied to clipboard
Adds a custom geometry to be used in the style.
addStyleCustomLayer
Link copied to clipboard
@NonNull
abstract fun addStyleCustomLayer(@NonNull layerId: String, @NonNull layerHost: CustomLayerHost, @Nullable layerPosition: LayerPosition): Expected<String, None>
Content copied to clipboard
Adds a new [style custom layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).
addStyleImage
Link copied to clipboard
@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>
Content copied to clipboard
Adds an image to be used in the style.
addStyleLayer
Link copied to clipboard
@NonNull
abstract fun addStyleLayer(@NonNull properties: Value, @Nullable layerPosition: LayerPosition): Expected<String, None>
Content copied to clipboard
Adds a new [style layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).
addStyleModel
Link copied to clipboard
@NonNull
abstract fun addStyleModel(@NonNull modelId: String, @NonNull modelUri: String): Expected<String, None>
Content copied to clipboard
Adds a model to be used in the style.
addStyleSource
Link copied to clipboard
@NonNull
abstract fun addStyleSource(@NonNull sourceId: String, @NonNull properties: Value): Expected<String, None>
Content copied to clipboard
Adds a new [style source](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources).
addViewAnnotation
Link copied to clipboard
@NonNull
abstract fun addViewAnnotation(@NonNull identifier: String, @NonNull options: ViewAnnotationOptions): Expected<String, None>
Content copied to clipboard
cameraForCoordinateBounds
Link copied to clipboard
@NonNull
abstract fun cameraForCoordinateBounds(@NonNull bounds: CoordinateBounds, @NonNull padding: EdgeInsets, @Nullable bearing: Double, @Nullable pitch: Double): CameraOptions
Content copied to clipboard
Convenience method that returns the `camera options` object for given parameters.
cameraForCoordinates
Link copied to clipboard
@NonNull
abstract fun cameraForCoordinates(@NonNull coordinates: List<Point>, @NonNull camera: CameraOptions, @NonNull box: ScreenBox): CameraOptions
Content copied to clipboard
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
Content copied to clipboard
Convenience method that returns the `camera options` object for given parameters.
cameraForGeometry
Link copied to clipboard
@NonNull
abstract fun cameraForGeometry(@NonNull geometry: Geometry, @NonNull padding: EdgeInsets, @Nullable bearing: Double, @Nullable pitch: Double): CameraOptions
Content copied to clipboard
Convenience method that returns the `camera options` object for given parameters.
coordinateBoundsForCamera
Link copied to clipboard
@NonNull
abstract fun coordinateBoundsForCamera(@NonNull camera: CameraOptions): CoordinateBounds
Content copied to clipboard
Returns the `coordinate bounds` for a given camera.
coordinateBoundsForCameraUnwrapped
Link copied to clipboard
@NonNull
abstract fun coordinateBoundsForCameraUnwrapped(@NonNull camera: CameraOptions): CoordinateBounds
Content copied to clipboard
Returns the `coordinate bounds` for a given camera.
coordinateBoundsZoomForCamera
Link copied to clipboard
@NonNull
abstract fun coordinateBoundsZoomForCamera(@NonNull camera: CameraOptions): CoordinateBoundsZoom
Content copied to clipboard
Returns the `coordinate bounds` and the `zoom` for a given `camera`.
coordinateBoundsZoomForCameraUnwrapped
Link copied to clipboard
@NonNull
abstract fun coordinateBoundsZoomForCameraUnwrapped(@NonNull camera: CameraOptions): CoordinateBoundsZoom
Content copied to clipboard
Returns the unwrapped `coordinate bounds` and `zoom` for a given `camera`.
coordinateForPixel
Link copied to clipboard
@NonNull
abstract fun coordinateForPixel(@NonNull pixel: ScreenCoordinate): Point
Content copied to clipboard
Calculates a geographical `coordinate` (i.e., longitude-latitude pair) that corresponds to a `screen coordinate`.
coordinateInfoForPixel
Link copied to clipboard
@NonNull
abstract fun coordinateInfoForPixel(@NonNull pixel: ScreenCoordinate): CoordinateInfo
Content copied to clipboard
Calculates the geographical coordinate information that corresponds to a given screen coordinate.
coordinatesForPixels
Link copied to clipboard
@NonNull
abstract fun coordinatesForPixels(@NonNull pixels: List<ScreenCoordinate>): List<Point>
Content copied to clipboard
Calculates geographical `coordinates` (i.e., longitude-latitude pairs) that correspond to `screen coordinates`.
coordinatesInfoForPixels
Link copied to clipboard
@NonNull
abstract fun coordinatesInfoForPixels(@NonNull pixels: List<ScreenCoordinate>): List<CoordinateInfo>
Content copied to clipboard
Calculates the geographical coordinates information that corresponds to the given screen coordinates.
createRenderer
Link copied to clipboard
abstract fun createRenderer()
Content copied to clipboard
Creates the infrastructure needed for rendering the map.
destroyRenderer
Link copied to clipboard
abstract fun destroyRenderer()
Content copied to clipboard
Destroys the infrastructure needed for rendering the map, releasing resources.
dragEnd
Link copied to clipboard
abstract fun dragEnd()
Content copied to clipboard
Ends the ongoing drag gesture.
dragStart
Link copied to clipboard
abstract fun dragStart(@NonNull point: ScreenCoordinate)
Content copied to clipboard
Prepares the drag gesture to use the provided screen coordinate as a pivot `point`.
getBounds
Link copied to clipboard
@NonNull
abstract fun getBounds(): CameraBounds
Content copied to clipboard
Returns the `camera bounds` of the map.
getCameraState
Link copied to clipboard
@NonNull
abstract fun getCameraState(): CameraState
Content copied to clipboard
Returns the current `camera state`.
getDebug
Link copied to clipboard
@NonNull
abstract fun getDebug(): List<MapDebugOptions>
Content copied to clipboard
Returns the `map debug options`.
getDragCameraOptions
Link copied to clipboard
@NonNull
abstract fun getDragCameraOptions(@NonNull fromPoint: ScreenCoordinate, @NonNull toPoint: ScreenCoordinate): CameraOptions
Content copied to clipboard
Calculates target point where camera should move after drag.
getElevation
Link copied to clipboard
@Nullable
abstract fun getElevation(@NonNull coordinate: Point): Double
Content copied to clipboard
Gets elevation for the given coordinate.
getFeatureState
Link copied to clipboard
abstract fun getFeatureState(@NonNull sourceId: String, @Nullable sourceLayerId: String, @NonNull featureId: String, @NonNull callback: QueryFeatureStateCallback)
Content copied to clipboard
Gets the state map of a feature within a style source.
getFreeCameraOptions
Link copied to clipboard
@NonNull
abstract fun getFreeCameraOptions(): FreeCameraOptions
Content copied to clipboard
Gets the map's current free camera options.
getMapOptions
Link copied to clipboard
@NonNull
abstract fun getMapOptions(): MapOptions
Content copied to clipboard
Returns the `map options`.
getPrefetchZoomDelta
Link copied to clipboard
abstract fun getPrefetchZoomDelta(): Byte
Content copied to clipboard
Returns the map's prefetch zoom delta.
getRenderCacheOptions
Link copied to clipboard
@NonNull
abstract fun getRenderCacheOptions(): RenderCacheOptions
Content copied to clipboard
Returns the `render cache options` used by the map.
getRenderWorldCopies
Link copied to clipboard
abstract fun getRenderWorldCopies(): Boolean
Content copied to clipboard
Returns whether multiple copies of the world are being rendered side by side beyond -180 and 180 degrees longitude.
getResourceOptions
Link copied to clipboard
@NonNull
abstract fun getResourceOptions(): ResourceOptions
Content copied to clipboard
Gets the resource options for the map.
getSize
Link copied to clipboard
@NonNull
abstract fun getSize(): Size
Content copied to clipboard
Gets the size of the map.
getStyleAtmosphereProperty
Link copied to clipboard
@NonNull
abstract fun getStyleAtmosphereProperty(@NonNull property: String): StylePropertyValue
Content copied to clipboard
Gets the value of a style atmosphere property.
getStyleDefaultCamera
Link copied to clipboard
@NonNull
abstract fun getStyleDefaultCamera(): CameraOptions
Content copied to clipboard
Returns the map style's default camera, if any, or a default camera otherwise.
getStyleImage
Link copied to clipboard
@Nullable
abstract fun getStyleImage(@NonNull imageId: String): Image
Content copied to clipboard
Get an `image` from the style.
getStyleJSON
Link copied to clipboard
@NonNull
abstract fun getStyleJSON(): String
Content copied to clipboard
Get the JSON serialization string of the current style in use.
getStyleLayerProperties
Link copied to clipboard
@NonNull
abstract fun getStyleLayerProperties(@NonNull layerId: String): Expected<String, Value>
Content copied to clipboard
Gets style layer properties.
getStyleLayerProperty
Link copied to clipboard
@NonNull
abstract fun getStyleLayerProperty(@NonNull layerId: String, @NonNull property: String): StylePropertyValue
Content copied to clipboard
Gets the value of style layer property.
getStyleLayers
Link copied to clipboard
@NonNull
abstract fun getStyleLayers(): List<StyleObjectInfo>
Content copied to clipboard
Returns the existing style layers.
getStyleLightProperty
Link copied to clipboard
@NonNull
abstract fun getStyleLightProperty(@NonNull property: String): StylePropertyValue
Content copied to clipboard
Gets the value of a style light property.
@NonNull
abstract fun getStyleLightProperty(@NonNull id: String, @NonNull property: String): StylePropertyValue
Content copied to clipboard
getStyleLights
Link copied to clipboard
@NonNull
abstract fun getStyleLights(): List<StyleObjectInfo>
Content copied to clipboard
getStyleProjectionProperty
Link copied to clipboard
@NonNull
abstract fun getStyleProjectionProperty(@NonNull property: String): StylePropertyValue
Content copied to clipboard
Gets the value of a style projection property.
getStyleSourceProperties
Link copied to clipboard
@NonNull
abstract fun getStyleSourceProperties(@NonNull sourceId: String): Expected<String, Value>
Content copied to clipboard
Gets style source properties.
getStyleSourceProperty
Link copied to clipboard
@NonNull
abstract fun getStyleSourceProperty(@NonNull sourceId: String, @NonNull property: String): StylePropertyValue
Content copied to clipboard
Gets the value of style source property.
getStyleSources
Link copied to clipboard
@NonNull
abstract fun getStyleSources(): List<StyleObjectInfo>
Content copied to clipboard
Returns the existing style sources.
getStyleTerrainProperty
Link copied to clipboard
@NonNull
abstract fun getStyleTerrainProperty(@NonNull property: String): StylePropertyValue
Content copied to clipboard
Gets the value of a style terrain property.
getStyleTransition
Link copied to clipboard
@NonNull
abstract fun getStyleTransition(): TransitionOptions
Content copied to clipboard
Returns the map style's transition options.
getStyleURI
Link copied to clipboard
@NonNull
abstract fun getStyleURI(): String
Content copied to clipboard
Get the URI of the current style in use.
getViewAnnotationOptions
Link copied to clipboard
@NonNull
abstract fun getViewAnnotationOptions(@NonNull identifier: String): Expected<String, ViewAnnotationOptions>
Content copied to clipboard
hasStyleImage
Link copied to clipboard
abstract fun hasStyleImage(@NonNull imageId: String): Boolean
Content copied to clipboard
Checks whether an image exists.
hasStyleModel
Link copied to clipboard
abstract fun hasStyleModel(@NonNull modelId: String): Boolean
Content copied to clipboard
Checks whether a model exists.
@NonNull
abstract fun invalidateStyleCustomGeometrySourceRegion(@NonNull sourceId: String, @NonNull bounds: CoordinateBounds): Expected<String, None>
Content copied to clipboard
Invalidate region for provided custom geometry source.
invalidateStyleCustomGeometrySourceTile
Link copied to clipboard
@NonNull
abstract fun invalidateStyleCustomGeometrySourceTile(@NonNull sourceId: String, @NonNull tileId: CanonicalTileID): Expected<String, None>
Content copied to clipboard
Invalidate tile for provided custom geometry source.
isGestureInProgress
Link copied to clipboard
abstract fun isGestureInProgress(): Boolean
Content copied to clipboard
Returns `true` if a gesture is currently in progress.
isMapLoaded
Link copied to clipboard
@Deprecated
abstract fun isMapLoaded(): Boolean
Content copied to clipboard
Returns `true` when the map is completely rendered, `false` otherwise.
isStyleLayerPersistent
Link copied to clipboard
@NonNull
abstract fun isStyleLayerPersistent(@NonNull layerId: String): Expected<String, Boolean>
Content copied to clipboard
Checks if a style layer is persistent.
isStyleLoaded
Link copied to clipboard
abstract fun isStyleLoaded(): Boolean
Content copied to clipboard
Check if the style is completely loaded.
isUserAnimationInProgress
Link copied to clipboard
abstract fun isUserAnimationInProgress(): Boolean
Content copied to clipboard
Returns `true` if user animation is currently in progress.
moveStyleLayer
Link copied to clipboard
@NonNull
abstract fun moveStyleLayer(@NonNull layerId: String, @Nullable layerPosition: LayerPosition): Expected<String, None>
Content copied to clipboard
Moves an existing style layer
pixelForCoordinate
Link copied to clipboard
@NonNull
abstract fun pixelForCoordinate(@NonNull coordinate: Point): ScreenCoordinate
Content copied to clipboard
Calculates a `screen coordinate` that corresponds to a geographical coordinate (i.e., longitude-latitude pair).
pixelsForCoordinates
Link copied to clipboard
@NonNull
abstract fun pixelsForCoordinates(@NonNull coordinates: List<Point>): List<ScreenCoordinate>
Content copied to clipboard
Calculates `screen coordinates` that correspond to geographical `coordinates` (i.e., longitude-latitude pairs).
queryFeatureExtensions
Link copied to clipboard
abstract fun queryFeatureExtensions(@NonNull sourceIdentifier: String, @NonNull feature: Feature, @NonNull extension: String, @NonNull extensionField: String, @Nullable args: HashMap<String, Value>, @NonNull callback: QueryFeatureExtensionCallback)
Content copied to clipboard
Queries for feature extension values in a GeoJSON source.
queryRenderedFeatures
Link copied to clipboard
@NonNull
abstract fun queryRenderedFeatures(@NonNull geometry: RenderedQueryGeometry, @NonNull options: RenderedQueryOptions, @NonNull callback: QueryFeaturesCallback): Cancelable
Content copied to clipboard
@Deprecated
abstract fun queryRenderedFeatures(@NonNull box: ScreenBox, @NonNull options: RenderedQueryOptions, @NonNull callback: QueryFeaturesCallback)
Content copied to clipboard
@Deprecated
abstract fun queryRenderedFeatures(@NonNull pixel: ScreenCoordinate, @NonNull options: RenderedQueryOptions, @NonNull callback: QueryFeaturesCallback)
Content copied to clipboard
@Deprecated
abstract fun queryRenderedFeatures(@NonNull shape: List<ScreenCoordinate>, @NonNull options: RenderedQueryOptions, @NonNull callback: QueryFeaturesCallback)
Content copied to clipboard
Queries the map for rendered features.
querySourceFeatures
Link copied to clipboard
abstract fun querySourceFeatures(@NonNull sourceId: String, @NonNull options: SourceQueryOptions, @NonNull callback: QueryFeaturesCallback)
Content copied to clipboard
Queries the map for source features.
reduceMemoryUse
Link copied to clipboard
abstract fun reduceMemoryUse()
Content copied to clipboard
Reduces memory use.
removeFeatureState
Link copied to clipboard
abstract fun removeFeatureState(@NonNull sourceId: String, @Nullable sourceLayerId: String, @NonNull featureId: String, @Nullable stateKey: String)
Content copied to clipboard
Removes entries from a feature state object.
removeStyleImage
Link copied to clipboard
@NonNull
abstract fun removeStyleImage(@NonNull imageId: String): Expected<String, None>
Content copied to clipboard
Removes an image from the style.
removeStyleLayer
Link copied to clipboard
@NonNull
abstract fun removeStyleLayer(@NonNull layerId: String): Expected<String, None>
Content copied to clipboard
Removes an existing style layer.
removeStyleModel
Link copied to clipboard
@NonNull
abstract fun removeStyleModel(@NonNull modelId: String): Expected<String, None>
Content copied to clipboard
Removes a model from the style.
removeStyleSource
Link copied to clipboard
@NonNull
abstract fun removeStyleSource(@NonNull sourceId: String): Expected<String, None>
Content copied to clipboard
Removes an existing style source.
removeViewAnnotation
Link copied to clipboard
@NonNull
abstract fun removeViewAnnotation(@NonNull identifier: String): Expected<String, None>
Content copied to clipboard
render
Link copied to clipboard
abstract fun render()
Content copied to clipboard
Renders the map.
setBounds
Link copied to clipboard
@NonNull
abstract fun setBounds(@NonNull options: CameraBoundsOptions): Expected<String, None>
Content copied to clipboard
Sets the `camera bounds options` of the map.
setCamera
Link copied to clipboard
abstract fun setCamera(@NonNull cameraOptions: CameraOptions)
Content copied to clipboard
Changes the map view by any combination of center, zoom, bearing, and pitch, without an animated transition.
abstract fun setCamera(@NonNull freeCameraOptions: FreeCameraOptions)
Content copied to clipboard
Sets the map view with the free camera options.
setConstrainMode
Link copied to clipboard
abstract fun setConstrainMode(@NonNull mode: ConstrainMode)
Content copied to clipboard
Sets the map `constrain mode`.
setDebug
Link copied to clipboard
abstract fun setDebug(@NonNull debugOptions: List<MapDebugOptions>, value: Boolean)
Content copied to clipboard
Sets the `map debug options` and enables debug mode based on the passed value.
setFeatureState
Link copied to clipboard
abstract fun setFeatureState(@NonNull sourceId: String, @Nullable sourceLayerId: String, @NonNull featureId: String, @NonNull state: Value)
Content copied to clipboard
Updates the state object of a feature within a style source.
setGestureInProgress
Link copied to clipboard
abstract fun setGestureInProgress(inProgress: Boolean)
Content copied to clipboard
Tells the map rendering engine that there is currently a gesture in progress.
setMemoryBudget
Link copied to clipboard
abstract fun setMemoryBudget(@Nullable memoryBudget: MapMemoryBudget)
Content copied to clipboard
setNorthOrientation
Link copied to clipboard
abstract fun setNorthOrientation(@NonNull orientation: NorthOrientation)
Content copied to clipboard
Sets the north `orientation mode`.
setPrefetchZoomDelta
Link copied to clipboard
abstract fun setPrefetchZoomDelta(delta: Byte)
Content copied to clipboard
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
Link copied to clipboard
abstract fun setRenderCacheOptions(@NonNull options: RenderCacheOptions)
Content copied to clipboard
Enables or disables the experimental render cache feature.
setRenderWorldCopies
Link copied to clipboard
abstract fun setRenderWorldCopies(renderWorldCopies: Boolean)
Content copied to clipboard
Sets whether multiple copies of the world will be rendered side by side beyond -180 and 180 degrees longitude.
setSize
Link copied to clipboard
abstract fun setSize(@NonNull size: Size)
Content copied to clipboard
Sets the size of the map.
setStyleAtmosphere
Link copied to clipboard
@NonNull
abstract fun setStyleAtmosphere(@NonNull properties: Value): Expected<String, None>
Content copied to clipboard
Sets the style global [atmosphere](https://docs.mapbox.com/mapbox-gl-js/style-spec/#fog) properties.
setStyleAtmosphereProperty
Link copied to clipboard
@NonNull
abstract fun setStyleAtmosphereProperty(@NonNull property: String, @NonNull value: Value): Expected<String, None>
Content copied to clipboard
Sets a value to the the style atmosphere property.
setStyleCustomGeometrySourceTileData
Link copied to clipboard
@NonNull
abstract fun setStyleCustomGeometrySourceTileData(@NonNull sourceId: String, @NonNull tileId: CanonicalTileID, @NonNull featureCollection: List<Feature>): Expected<String, None>
Content copied to clipboard
Set tile data of a custom geometry.
setStyleGeoJSONSourceData
Link copied to clipboard
@NonNull
@Deprecated
abstract fun setStyleGeoJSONSourceData(@NonNull sourceId: String, @NonNull data: GeoJSONSourceData): Expected<String, None>
Content copied to clipboard
@NonNull
abstract fun setStyleGeoJSONSourceData(@NonNull sourceId: String, @NonNull dataId: String, @NonNull data: GeoJSONSourceData): Expected<String, None>
Content copied to clipboard
setStyleJSON
Link copied to clipboard
abstract fun setStyleJSON(@NonNull json: String)
Content copied to clipboard
Load the style from a provided JSON string.
setStyleLayerProperties
Link copied to clipboard
@NonNull
abstract fun setStyleLayerProperties(@NonNull layerId: String, @NonNull properties: Value): Expected<String, None>
Content copied to clipboard
Sets style layer properties.
setStyleLayerProperty
Link copied to clipboard
@NonNull
abstract fun setStyleLayerProperty(@NonNull layerId: String, @NonNull property: String, @NonNull value: Value): Expected<String, None>
Content copied to clipboard
Sets a value to a style layer property.
setStyleLight
Link copied to clipboard
@NonNull
abstract fun setStyleLight(@NonNull properties: Value): Expected<String, None>
Content copied to clipboard
Sets the style global [light](https://docs.mapbox.com/mapbox-gl-js/style-spec/#light) properties.
setStyleLightProperty
Link copied to clipboard
@NonNull
abstract fun setStyleLightProperty(@NonNull property: String, @NonNull value: Value): Expected<String, None>
Content copied to clipboard
Sets a value to the the style light property.
@NonNull
abstract fun setStyleLightProperty(@NonNull id: String, @NonNull property: String, @NonNull value: Value): Expected<String, None>
Content copied to clipboard
setStyleLights
Link copied to clipboard
@NonNull
abstract fun setStyleLights(@NonNull lights: Value): Expected<String, None>
Content copied to clipboard
setStyleProjection
Link copied to clipboard
@NonNull
abstract fun setStyleProjection(@NonNull properties: Value): Expected<String, None>
Content copied to clipboard
Sets the map's [projection](https://docs.mapbox.com/mapbox-gl-js/style-spec/projection/).
setStyleProjectionProperty
Link copied to clipboard
@NonNull
abstract fun setStyleProjectionProperty(@NonNull property: String, @NonNull value: Value): Expected<String, None>
Content copied to clipboard
Sets a value to the the style projection property.
setStyleSourceProperties
Link copied to clipboard
@NonNull
abstract fun setStyleSourceProperties(@NonNull sourceId: String, @NonNull properties: Value): Expected<String, None>
Content copied to clipboard
Sets style source properties.
setStyleSourceProperty
Link copied to clipboard
@NonNull
abstract fun setStyleSourceProperty(@NonNull sourceId: String, @NonNull property: String, @NonNull value: Value): Expected<String, None>
Content copied to clipboard
Sets a value to a style source property.
setStyleTerrain
Link copied to clipboard
@NonNull
abstract fun setStyleTerrain(@NonNull properties: Value): Expected<String, None>
Content copied to clipboard
Sets the style global [terrain](https://docs.mapbox.com/mapbox-gl-js/style-spec/#terrain) properties.
setStyleTerrainProperty
Link copied to clipboard
@NonNull
abstract fun setStyleTerrainProperty(@NonNull property: String, @NonNull value: Value): Expected<String, None>
Content copied to clipboard
Sets a value to the the style terrain property.
setStyleTransition
Link copied to clipboard
abstract fun setStyleTransition(@NonNull transitionOptions: TransitionOptions)
Content copied to clipboard
Overrides the map style's transition options with user-provided options.
setStyleURI
Link copied to clipboard
abstract fun setStyleURI(@NonNull uri: String)
Content copied to clipboard
Load style from provided URI.
setUserAnimationInProgress
Link copied to clipboard
abstract fun setUserAnimationInProgress(inProgress: Boolean)
Content copied to clipboard
Tells the map rendering engine that the animation is currently performed by the user (e.g.
abstract fun setViewAnnotationPositionsUpdateListener(@Nullable listener: ViewAnnotationPositionsUpdateListener)
Content copied to clipboard
setViewportMode
Link copied to clipboard
abstract fun setViewportMode(@NonNull mode: ViewportMode)
Content copied to clipboard
Sets the `viewport mode`.
styleLayerExists
Link copied to clipboard
abstract fun styleLayerExists(@NonNull layerId: String): Boolean
Content copied to clipboard
Checks whether a given style layer exists.
styleSourceExists
Link copied to clipboard
abstract fun styleSourceExists(@NonNull sourceId: String): Boolean
Content copied to clipboard
Checks whether a given style source exists.
subscribe
Link copied to clipboard
abstract fun subscribe(@NonNull observer: Observer, @NonNull events: List<String>)
Content copied to clipboard
Subscribes an `observer` to a provided array of event types.
tileCover
Link copied to clipboard
@NonNull
abstract fun tileCover(@NonNull tileCoverOptions: TileCoverOptions, @Nullable cameraOptions: CameraOptions): List<CanonicalTileID>
Content copied to clipboard
triggerRepaint
Link copied to clipboard
abstract fun triggerRepaint()
Content copied to clipboard
Triggers a repaint of the map.
unsubscribe
Link copied to clipboard
abstract fun unsubscribe(@NonNull observer: Observer)
Content copied to clipboard
Unsubscribes an `observer` from all events.
abstract fun unsubscribe(@NonNull observer: Observer, @NonNull events: List<String>)
Content copied to clipboard
Unsubscribes an `observer` from a provided array of event types.
updateStyleImageSourceImage
Link copied to clipboard
@NonNull
abstract fun updateStyleImageSourceImage(@NonNull sourceId: String, @NonNull image: Image): Expected<String, None>
Content copied to clipboard
Updates the image of an [image style source](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources-image).
updateViewAnnotation
Link copied to clipboard
@NonNull
abstract fun updateViewAnnotation(@NonNull identifier: String, @NonNull options: ViewAnnotationOptions): Expected<String, None>
Content copied to clipboard