MapboxMap

A convenience object to access MapboxMap's static utilities.

Add a listener that's going to be invoked whenever map camera changes.

Add a listener that's going to be invoked whenever map has entered the idle state.

The Map is in the idle state when there are no ongoing transitions and the Map has rendered all available tiles.

Add a listener that's going to be invoked whenever the Map's style has been fully loaded, and the Map has rendered all visible tiles.

Add a listener that's going to be invoked whenever there's a map load error.

Add a listener that's going to be invoked whenever the Map finished rendering a frame.

The render-mode value tells whether the Map has all data ("full") required to render the visible viewport. The needs-repaint value provides information about ongoing transitions that trigger Map repaint. The placement-changed value tells if the symbol placement has been changed in the visible viewport.

Add a listener that's going to be invoked whenever the Map started rendering a frame.

Add a listener that's going to be invoked whenever a source has been added with StyleManager#addStyleSource runtime API.

Add a listener that's going to be invoked whenever the source data has been loaded.

Add a listener that's going to be invoked whenever a source has been removed with StyleManager#removeStyleSource runtime API.

Add a listener that's going to be invoked whenever the requested style data been loaded. The 'type' property defines what kind of style data has been loaded.

This event may be useful when application needs to modify style layers or sources and add or remove sources before style is fully loaded.

Add a listener that's going to be invoked whenever a style has a missing image.

This event is emitted when the Map renders visible tiles and one of the required images is missing in the sprite sheet.

Add a listener that's going to be invoked whenever an image added to the Style is no longer needed and can be removed using StyleManager#removeStyleImage method.

Add a listener that's going to be invoked whenever the requested style has been fully loaded, including the style specified sprite and sources.

Call extension function on CameraAnimationsPlugin. In most cases should not be called directly.

Convert to a camera options from a given LatLngBounds, padding, bearing and pitch values.

In order for this method to produce correct results MapView must be already measured and inflated to have correct width and height values. Calling this method in Activity.onCreate will lead to incorrect results.

Convenience method that returns the camera options object for given arguments

In order for this method to produce correct results MapView must be already measured and inflated to have correct width and height values. Calling this method in Activity.onCreate will lead to incorrect results.

Returns the camera options object for given arguments with zoom adjusted to fit \p coordinates into \p box, so that coordinates on the left, top and right of \p camera.center fit into \p box. Returns the provided camera options object unchanged upon error.

Convert to a camera options from a given list of points, padding, bearing and pitch values.

In order for this method to produce correct results MapView must be already measured and inflated to have correct width and height values. Calling this method in Activity.onCreate will lead to incorrect results.

Convert to a camera options from a given geometry, padding, bearing and pitch values.

In order for this method to produce correct results MapView must be already measured and inflated to have correct width and height values. Calling this method in Activity.onCreate will lead to incorrect results.

Clears temporary map data.

Clears temporary map data from the data path defined in the given resource options. Useful to reduce the disk usage or in case the disk cache contains invalid data.

Note that calling this API will affect all maps that use the same data path and does not affect persistent map data like offline style packages.

Convert to a LatLngBounds from a given camera options.

In order for this method to produce correct results MapView must be already measured and inflated to have correct width and height values. Calling this method in Activity.onCreate will lead to incorrect results.

Returns the coordinate bounds and zoom for a given camera.

In order for this method to produce correct results MapView must be already measured and inflated to have correct width and height values. Calling this method in Activity.onCreate will lead to incorrect results.

Note that if the given camera shows the antimeridian, the returned wrapped bounds might not represent the minimum bounding box.

See also {@link #coordinateBoundsZoomForCameraUnwrapped}

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

In order for this method to produce correct results MapView must be already measured and inflated to have correct width and height values. Calling this method in Activity.onCreate will lead to incorrect results.

This method is particularly useful, if the camera shows the antimeridian.

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

The screen coordinate is in MapOptions.size platform pixels relative to the top left of the map (not of the whole screen).

Map must be fully loaded for getting an altitude-compliant result if using 3D terrain.

Calculate a longitude-latitude pair for a Spherical Mercator projected meters.

Calculate geographical coordinates(i.e., longitude-latitude pair) that corresponds to screen coordinates.

The screen coordinates are in MapOptions.size platform pixels relative to the top left of the map (not of the whole screen).

Map must be fully loaded for getting an altitude-compliant result if using 3D terrain.

Ends the ongoing drag gesture. This function should be called always after the user has ended a drag gesture initiated by dragStart.

Prepares the drag gesture to use the provided screen coordinate as a pivot point. This function should be called each time when user starts a dragging action (e.g. by clicking on the map). The following dragging will be relative to the pivot.

In some cases querying source / render features is expected to be a blocking operation e.g. performing this action on map click. In this case in order to avoid deadlock on main thread querying could be performed on render thread and in that case querying result will be also delivered on render thread not leading to the main thread deadlock. Example:

fun onMapClick() { executeOnRenderThread { queryRenderedFeatures(pixel, options) { // result callback called, do needed actions lock.notify() } } lock.wait() return false }

Call extension function on GesturesPlugin. In most cases should not be called directly.

Get the map bounds options.

Get debug options

Calculates target point where camera should move after drag. The method should be called after dragStart and before dragEnd.

Get elevation for given coordinate. Value is available only for the visible region on the screen, if terrain (DEM) tile is available.

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

Note that updates to feature state are asynchronous, so changes made by other methods might not be immediately visible.

Get the map's current free camera options. After mutation, it should be set back to the map.

Get map options.

Get current map projection for Mapbox map.

Please note that even if MapboxMap is configured to use MapProjection.Globe starting from MapProjection.TRANSITION_ZOOM_LEVEL and above this method will return MapProjection.Mercator.

Calculate distance spanned by one pixel at the specified latitude at current zoom level.

Calculate distance spanned by one pixel at the specified latitude and zoom level.

Get the prefetch zoom delta

Get the current RenderCacheOptions.

The size of the render cache is in megabytes. Returned value is zero if the feature is disabled.

Get the ResourceOptions the map was initialized with.

Gets the size of the map.

Get the Style of the map synchronously, will return null is style is not loaded yet.

Get the Style of the map asynchronously.

Returns if the style has been fully loaded.

Returns if a gesture is in progress.

Returns if user animation is currently in progress.

Load the style from Style Extension.

Load style JSON.

Load style JSON

Will load a new map style asynchronous from the specified URI.

Will load a new map style asynchronous from the specified URI.

URI can take the following forms:

• Constants: load one of the bundled styles in Style.

• mapbox://styles/<user>/<style>: loads the style from a Mapbox account. user is your username. style is the ID of your custom style created in Mapbox Studio.

• http://... or https://...: loads the style over the Internet from any web server.

• asset://...: loads the style from the APK assets directory. This is used to load a style bundled with your app.

• file://...: loads the style from a file path. This is used to load a style from disk.

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

The screen coordinate is in MapOptions.size platform pixels relative to the top left of the map (not of the whole screen).

Map must be fully loaded for getting an altitude-compliant result if using 3D terrain.

Calculate screen coordinates that corresponds to geographical coordinates (i.e., longitude-latitude pair).

The screen coordinates are in MapOptions.size platform pixels relative to the top left of the map (not of the whole screen).

Map must be fully loaded for getting an altitude-compliant result if using 3D terrain.

Calculate a point on the map in Mercator Projection for a given coordinate at the specified zoom scale.

Calculate Spherical Mercator ProjectedMeters coordinates.

Queries for feature extension values in a GeoJSON source.

Queries the map for rendered features.

Queries the map for source features.

Reduce memory use. Useful to call when the application gets paused or sent to background.

Remove entries from a feature state map.

Remove a specified entry or all entries from a feature's state map, depending on the value of stateKey.

Note that updates to feature state are asynchronous, so changes made by this method migth not be immediately visible using getStateFeature().

Remove the camera change listener.

Remove the map idle listener.

Remove the map loaded listener.

Remove the map error listener.

Remove the render frame finished listener.

Remove the render frame started listener.

Remove the source added listener.

Remove the source data loaded listener.

Remove the source removed listener.

Remove the style data loaded listener

Remove the style image missing listener.

Remove the style image unused listener.

Remove the style loaded listener.

Set the map bounds.

Changes the map view by any combination of center, zoom, bearing, and pitch, without an animated transition. The map will retain its current values for any details not passed via the camera options argument. It is not guaranteed that the provided CameraOptions will be set, the map may apply constraints resulting in a different CameraState.

Sets the map view with the free camera options.

FreeCameraOptions provides more direct access to the underlying camera entity. For backwards compatibility the state set using this API must be representable with CameraOptions as well. Parameters are clamped to a valid range or discarded as invalid if the conversion to the pitch and bearing presentation is ambiguous. For example orientation can be invalid if it leads to the camera being upside down or the quaternion has zero length.

Set the map constrain mode

Set debug options

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

Update entries in the state map of a given feature within a style source. Only entries listed in the \p state map will be updated. An entry in the feature state map that is not listed in \p state will retain its previous value.

Note that updates to feature state are asynchronous, so changes made by this method migth not be immediately visible using getStateFeature().

Notify map about gesture being in progress.

Set map projection for Mapbox map.

Set the map north orientation

Set the prefetch zoom delta

Enables or disables the experimental render cache feature.

Render cache is an experimental feature aiming to reduce resource usage of map rendering by caching intermediate rendering results of tiles into specific cache textures for reuse between frames. Performance benefit of the cache depends on the style as not all layers are cacheable due to e.g. viewport aligned features. Render cache always prefers quality over performance.

If RenderCacheOptions.size is not specified explicitly when using RenderCacheOptions.Builder - render cache will be disabled. If RenderCacheOptions.size is less than zero - IllegalArgumentException will be thrown.

Tells the map rendering engine that the animation is currently performed by the user (e.g. with a setCamera() calls series). It adjusts the engine for the animation use case. In particular, it brings more stability to symbol placement and rendering.

Set the map viewport mode

Subscribes an Observer to a provided list of event types. Observable will hold a strong reference to an \sa Observer instance, therefore, in order to stop receiving notifications, caller must call unsubscribe with an \sa Observer instance used for an initial subscription.

Triggers a repaint of the map.

Calculate a coordinate for a given point on the map in Mercator Projection.

Unsubscribes an Observer from all events.

Unsubscribes an Observer from a provided list of event types.