MapLibre Native Android/org.maplibre.android.maps/MapLibreMap

MapLibreMap

@UiThread
class MapLibreMap

The general class to interact with in the Android MapLibre SDK. It exposes the entry point for all methods related to the MapView. You cannot instantiate MapLibreMap object directly, rather, you must obtain one from the getMapAsync() method on a MapFragment or MapView that you have added to your application.

Note: Similar to a View object, a MapLibreMap should only be read and modified from the main thread.

Types

Link copied to clipboard
interface CancelableCallback
Interface definition for a callback to be invoked when a task is complete or cancelled.
Link copied to clipboard
interface InfoWindowAdapter
Interface definition for a callback to be invoked when an info window will be shown.
Link copied to clipboard
interface OnCameraIdleListener
Interface definition for a callback to be invoked for when camera movement has ended.
Link copied to clipboard
interface OnCameraMoveCanceledListener
Interface definition for a callback to be invoked for when the camera's motion has been stopped or when the camera starts moving for a new reason.
Link copied to clipboard
interface OnCameraMoveListener
Interface definition for a callback to be invoked for when the camera changes position.
Link copied to clipboard
interface OnCameraMoveStartedListener
Interface definition for a callback to be invoked for when the camera motion starts.
Link copied to clipboard
interface OnCompassAnimationListener
Interface definition for a callback to be invoked for when the compass is animating.
Link copied to clipboard
interface OnDeveloperAnimationListener
Internal use.
Link copied to clipboard
interface OnFlingListener
Interface definition for a callback to be invoked when the map is flinged.
Link copied to clipboard
interface OnFpsChangedListener
Interface definition for a callback to be invoked when a frame is rendered to the map view.
Link copied to clipboard
interface OnInfoWindowClickListener
Interface definition for a callback to be invoked when the user clicks on an info window.
Link copied to clipboard
interface OnInfoWindowCloseListener
Interface definition for a callback to be invoked when a marker's info window is closed.
Link copied to clipboard
interface OnInfoWindowLongClickListener
Interface definition for a callback to be invoked when the user long presses on a marker's info window.
Link copied to clipboard
interface OnMapClickListener
Interface definition for a callback to be invoked when the user clicks on the map view.
Link copied to clipboard
interface OnMapLongClickListener
Interface definition for a callback to be invoked when the user long clicks on the map view.
Link copied to clipboard
interface OnMarkerClickListener
Interface definition for a callback to be invoked when the user clicks on a marker.
Link copied to clipboard
interface OnMoveListener
Interface definition for a callback to be invoked when the map is moved.
Link copied to clipboard
interface OnPolygonClickListener
Interface definition for a callback to be invoked when the user clicks on a polygon.
Link copied to clipboard
interface OnPolylineClickListener
Interface definition for a callback to be invoked when the user clicks on a polyline.
Link copied to clipboard
interface OnRotateListener
Interface definition for a callback to be invoked when the map is rotated.
Link copied to clipboard
interface OnScaleListener
Interface definition for a callback to be invoked when the map is scaled.
Link copied to clipboard
interface OnShoveListener
Interface definition for a callback to be invoked when the map is tilted.
Link copied to clipboard
interface SnapshotReadyCallback
Interface definition for a callback to be invoked when the snapshot has been taken.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@Nullable
@get:Nullable
open val style: Style
Link copied to clipboard

Functions

Link copied to clipboard
@NonNull
open fun addMarker(@NonNull markerOptions: BaseMarkerOptions): Marker
@NonNull
open fun addMarker(@NonNull markerOptions: MarkerOptions): Marker
Adds a marker to this map.
Link copied to clipboard
@NonNull
open fun addMarkers(@NonNull markerOptionsList: List<out BaseMarkerOptions>): List<Marker>
Adds multiple markers to this map.
Link copied to clipboard
open fun addOnCameraIdleListener(@NonNull listener: MapLibreMap.OnCameraIdleListener)
Adds a callback that is invoked when camera movement has ended.
Link copied to clipboard
open fun addOnCameraMoveCancelListener(@NonNull listener: MapLibreMap.OnCameraMoveCanceledListener)
Adds a callback that is invoked when camera movement was cancelled.
Link copied to clipboard
open fun addOnCameraMoveListener(@NonNull listener: MapLibreMap.OnCameraMoveListener)
Adds a callback that is invoked when camera position changes.
Link copied to clipboard
open fun addOnCameraMoveStartedListener(@NonNull listener: MapLibreMap.OnCameraMoveStartedListener)
Adds a callback that is invoked when camera movement has started.
Link copied to clipboard
open fun addOnFlingListener(@NonNull listener: MapLibreMap.OnFlingListener)
Adds a callback that's invoked when the map is flinged.
Link copied to clipboard
open fun addOnMapClickListener(@NonNull listener: MapLibreMap.OnMapClickListener)
Adds a callback that's invoked when the user clicks on the map view.
Link copied to clipboard
open fun addOnMapLongClickListener(@NonNull listener: MapLibreMap.OnMapLongClickListener)
Adds a callback that's invoked when the user long clicks on the map view.
Link copied to clipboard
open fun addOnMoveListener(@NonNull listener: MapLibreMap.OnMoveListener)
Adds a callback that's invoked when the map is moved.
Link copied to clipboard
open fun addOnRotateListener(@NonNull listener: MapLibreMap.OnRotateListener)
Adds a callback that's invoked when the map is rotated.
Link copied to clipboard
open fun addOnScaleListener(@NonNull listener: MapLibreMap.OnScaleListener)
Adds a callback that's invoked when the map is scaled.
Link copied to clipboard
open fun addOnShoveListener(@NonNull listener: MapLibreMap.OnShoveListener)
Adds a callback that's invoked when the map is tilted.
Link copied to clipboard
@NonNull
open fun addPolygon(@NonNull polygonOptions: PolygonOptions): Polygon
Adds a polygon to this map.
Link copied to clipboard
@NonNull
open fun addPolygons(@NonNull polygonOptionsList: List<PolygonOptions>): List<Polygon>
Adds multiple polygons to this map.
Link copied to clipboard
@NonNull
open fun addPolyline(@NonNull polylineOptions: PolylineOptions): Polyline
Adds a polyline to this map.
Link copied to clipboard
@NonNull
open fun addPolylines(@NonNull polylineOptionsList: List<PolylineOptions>): List<Polyline>
Adds multiple polylines to this map.
Link copied to clipboard
fun animateCamera(@NonNull update: CameraUpdate)
fun animateCamera(@NonNull update: CameraUpdate, durationMs: Int)
fun animateCamera(@NonNull update: CameraUpdate, @Nullable callback: MapLibreMap.CancelableCallback)
fun animateCamera(@NonNull update: CameraUpdate, durationMs: Int, @Nullable callback: MapLibreMap.CancelableCallback)
Animate the camera to a new location defined within CameraUpdate using a transition animation that evokes powered flight.
Link copied to clipboard
open fun cancelAllVelocityAnimations()
Interrupts any ongoing gesture velocity animations.
Link copied to clipboard
open fun cancelTransitions()
Cancels ongoing animations.
Link copied to clipboard
open fun clear()
Removes all markers, polylines, polygons, overlays, etc from the map.
Link copied to clipboard
open fun cycleDebugOptions()
Cycles through the map debug options.
Link copied to clipboard
open fun deselectMarker(@NonNull marker: Marker)
Deselects a currently selected marker.
Link copied to clipboard
open fun deselectMarkers()
Deselects any currently selected marker.
Link copied to clipboard
fun easeCamera(@NonNull update: CameraUpdate)
fun easeCamera(@NonNull update: CameraUpdate, @Nullable callback: MapLibreMap.CancelableCallback)
Gradually move the camera by the default duration, zoom will not be affected unless specified within CameraUpdate.
fun easeCamera(@NonNull update: CameraUpdate, durationMs: Int)
fun easeCamera(@NonNull update: CameraUpdate, durationMs: Int, easingInterpolator: Boolean)
fun easeCamera(@NonNull update: CameraUpdate, durationMs: Int, @Nullable callback: MapLibreMap.CancelableCallback)
fun easeCamera(@NonNull update: CameraUpdate, durationMs: Int, easingInterpolator: Boolean, @Nullable callback: MapLibreMap.CancelableCallback)
Gradually move the camera by a specified duration in milliseconds, zoom will not be affected unless specified within CameraUpdate.
Link copied to clipboard
@Nullable
open fun getAnnotation(id: Long): Annotation
Return a annotation based on its id.
Link copied to clipboard
@NonNull
open fun getAnnotations(): List<Annotation>
Returns a list of all the annotations on the map.
Link copied to clipboard
@Nullable
open fun getCameraForGeometry(@NonNull geometry: Geometry): CameraPosition
Get a camera position that fits a provided shape.
@Nullable
open fun getCameraForGeometry(@NonNull geometry: Geometry, @NonNull @Size(value = 4) padding: Array<Int>): CameraPosition
Get a camera position that fits a provided shape and padding.
@Nullable
open fun getCameraForGeometry(@NonNull geometry: Geometry, @FloatRange(from = MapLibreConstants.MINIMUM_DIRECTION, to = MapLibreConstants.MAXIMUM_DIRECTION) bearing: Double, @FloatRange(from = MapLibreConstants.MINIMUM_TILT, to = MapLibreConstants.MAXIMUM_TILT) tilt: Double): CameraPosition
Get a camera position that fits a provided shape with a given bearing and tilt.
@Nullable
open fun getCameraForGeometry(@NonNull geometry: Geometry, @NonNull @Size(value = 4) padding: Array<Int>, @FloatRange(from = MapLibreConstants.MINIMUM_DIRECTION, to = MapLibreConstants.MAXIMUM_DIRECTION) bearing: Double, @FloatRange(from = MapLibreConstants.MINIMUM_TILT, to = MapLibreConstants.MAXIMUM_TILT) tilt: Double): CameraPosition
Get a camera position that fits a provided shape with a given padding, bearing and tilt.
Link copied to clipboard
@Nullable
open fun getCameraForLatLngBounds(@NonNull latLngBounds: LatLngBounds): CameraPosition
Get a camera position that fits a provided bounds and the current camera tilt and bearing.
@Nullable
open fun getCameraForLatLngBounds(@NonNull latLngBounds: LatLngBounds, @NonNull @Size(value = 4) padding: Array<Int>): CameraPosition
Get a camera position that fits a provided bounds and padding and the current camera tilt and bearing.
@Nullable
open fun getCameraForLatLngBounds(@NonNull latLngBounds: LatLngBounds, @FloatRange(from = MapLibreConstants.MINIMUM_DIRECTION, to = MapLibreConstants.MAXIMUM_DIRECTION) bearing: Double, @FloatRange(from = MapLibreConstants.MINIMUM_TILT, to = MapLibreConstants.MAXIMUM_TILT) tilt: Double): CameraPosition
Get a camera position that fits a provided bounds, bearing and tilt.
@Nullable
open fun getCameraForLatLngBounds(@NonNull latLngBounds: LatLngBounds, @NonNull @Size(value = 4) padding: Array<Int>, @FloatRange(from = MapLibreConstants.MINIMUM_DIRECTION, to = MapLibreConstants.MAXIMUM_DIRECTION) bearing: Double, @FloatRange(from = MapLibreConstants.MINIMUM_TILT, to = MapLibreConstants.MAXIMUM_TILT) tilt: Double): CameraPosition
Get a camera position that fits a provided bounds, padding, bearing and tilt.
Link copied to clipboard
@NonNull
fun getCameraPosition(): CameraPosition
Gets the current position of the camera.
Link copied to clipboard
@NonNull
open fun getGesturesManager(): AndroidGesturesManager
Get current AndroidGesturesManager that handles android.view.MotionEvents registered by the MapView
Link copied to clipboard
open fun getHeight(): Float
Returns the measured height of the Map.
Link copied to clipboard
@Nullable
open fun getInfoWindowAdapter(): MapLibreMap.InfoWindowAdapter
Gets the callback to be invoked when an info window will be shown.
Link copied to clipboard
@NonNull
open fun getMarkers(): List<Marker>
Returns a list of all the markers on the map.
Link copied to clipboard
open fun getMaxPitch(): Double
Gets the maximum Pitch the map can be displayed at.
Link copied to clipboard
open fun getMaxZoomLevel(): Double
Gets the maximum zoom level the map can be displayed at.
Link copied to clipboard
open fun getMinPitch(): Double
Gets the minimum Pitch the map can be displayed at.
Link copied to clipboard
open fun getMinZoomLevel(): Double
Gets the minimum zoom level the map can be displayed at.
Link copied to clipboard
@Nullable
open fun getOnInfoWindowClickListener(): MapLibreMap.OnInfoWindowClickListener
Return the InfoWindow click listener
Link copied to clipboard
@Nullable
open fun getOnInfoWindowCloseListener(): MapLibreMap.OnInfoWindowCloseListener
Return the InfoWindow close listener
Link copied to clipboard
@Nullable
open fun getOnInfoWindowLongClickListener(): MapLibreMap.OnInfoWindowLongClickListener
Return the InfoWindow long click listener
Link copied to clipboard
@NonNull
open fun getPadding(): Array<Int>
Returns the current configured content padding on map view.
Link copied to clipboard
@NonNull
open fun getPolygons(): List<Polygon>
Returns a list of all the polygons on the map.
Link copied to clipboard
@NonNull
open fun getPolylines(): List<Polyline>
Returns a list of all the polylines on the map.
Link copied to clipboard
open fun getPrefetchesTiles(): Boolean
Check whether tile pre-fetching is enabled or not.
Link copied to clipboard
@IntRange(from = 0)
open fun getPrefetchZoomDelta(): Int
Check current pre-fetching zoom delta.
Link copied to clipboard
@NonNull
open fun getSelectedMarkers(): List<Marker>
Gets the currently selected marker.
Link copied to clipboard
open fun getStyle(@NonNull onStyleLoaded: Style.OnStyleLoaded)
Get the Style of the map asynchronously.
Link copied to clipboard
open fun getTileCacheEnabled(): Boolean
Check whether tile cache is enabled or not.
Link copied to clipboard
open fun getWidth(): Float
Returns the measured width of the Map.
Link copied to clipboard
open fun getZoom(): Double
Returns the current zoom level.
Link copied to clipboard
open fun isAllowConcurrentMultipleOpenInfoWindows(): Boolean
Returns whether the map allows concurrent multiple infowindows to be shown.
Link copied to clipboard
open fun isDebugActive(): Boolean
Returns whether the map debug information is currently shown.
Link copied to clipboard
fun moveCamera(@NonNull update: CameraUpdate)
fun moveCamera(@NonNull update: CameraUpdate, @Nullable callback: MapLibreMap.CancelableCallback)
Repositions the camera according to the instructions defined in the update.
Link copied to clipboard
@NonNull
open fun queryRenderedFeatures(@NonNull coordinates: PointF, @Nullable layerIds: Array<String>): List<Feature>
Queries the map for rendered features.
@NonNull
open fun queryRenderedFeatures(@NonNull coordinates: RectF, @Nullable layerIds: Array<String>): List<Feature>
@NonNull
open fun queryRenderedFeatures(@NonNull coordinates: PointF, @Nullable filter: Expression, @Nullable layerIds: Array<String>): List<Feature>
@NonNull
open fun queryRenderedFeatures(@NonNull coordinates: RectF, @Nullable filter: Expression, @Nullable layerIds: Array<String>): List<Feature>
Queries the map for rendered features Returns an empty list if either the map or underlying render surface has been destroyed.
Link copied to clipboard
open fun removeAnnotation(id: Long)
Removes an annotation from the map
open fun removeAnnotation(@NonNull annotation: Annotation)
Removes an annotation from the map.
Link copied to clipboard
open fun removeAnnotations()
Removes all annotations from the map.
open fun removeAnnotations(@NonNull annotationList: List<out Annotation>)
Removes multiple annotations from the map.
Link copied to clipboard
open fun removeMarker(@NonNull marker: Marker)
Convenience method for removing a Marker from the map.
Link copied to clipboard
open fun removeOnCameraIdleListener(@NonNull listener: MapLibreMap.OnCameraIdleListener)
Removes a callback that is invoked when camera movement has ended.
Link copied to clipboard
open fun removeOnCameraMoveCancelListener(@NonNull listener: MapLibreMap.OnCameraMoveCanceledListener)
Removes a callback that is invoked when camera movement was cancelled.
Link copied to clipboard
open fun removeOnCameraMoveListener(@NonNull listener: MapLibreMap.OnCameraMoveListener)
Removes a callback that is invoked when camera position changes.
Link copied to clipboard
open fun removeOnCameraMoveStartedListener(@NonNull listener: MapLibreMap.OnCameraMoveStartedListener)
Removes a callback that is invoked when camera movement has started.
Link copied to clipboard
open fun removeOnFlingListener(@NonNull listener: MapLibreMap.OnFlingListener)
Removes a callback that's invoked when the map is flinged.
Link copied to clipboard
open fun removeOnMapClickListener(@NonNull listener: MapLibreMap.OnMapClickListener)
Removes a callback that's invoked when the user clicks on the map view.
Link copied to clipboard
open fun removeOnMapLongClickListener(@NonNull listener: MapLibreMap.OnMapLongClickListener)
Removes a callback that's invoked when the user long clicks on the map view.
Link copied to clipboard
open fun removeOnMoveListener(@NonNull listener: MapLibreMap.OnMoveListener)
Removes a callback that's invoked when the map is moved.
Link copied to clipboard
open fun removeOnRotateListener(@NonNull listener: MapLibreMap.OnRotateListener)
Removes a callback that's invoked when the map is rotated.
Link copied to clipboard
open fun removeOnScaleListener(@NonNull listener: MapLibreMap.OnScaleListener)
Removes a callback that's invoked when the map is scaled.
Link copied to clipboard
open fun removeOnShoveListener(@NonNull listener: MapLibreMap.OnShoveListener)
Remove a callback that's invoked when the map is tilted.
Link copied to clipboard
open fun removePolygon(@NonNull polygon: Polygon)
Convenience method for removing a Polygon from the map.
Link copied to clipboard
open fun removePolyline(@NonNull polyline: Polyline)
Convenience method for removing a Polyline from the map.
Link copied to clipboard
open fun resetNorth()
Resets the map view to face north.
Link copied to clipboard
open fun scrollBy(x: Float, y: Float)
open fun scrollBy(x: Float, y: Float, duration: Long)
Scrolls the camera over the map, shifting the center of view by the specified number of pixels in the x and y directions.
Link copied to clipboard
open fun selectMarker(@NonNull marker: Marker)
Selects a marker.
open fun setAllowConcurrentMultipleOpenInfoWindows(allow: Boolean)
Changes whether the map allows concurrent multiple infowindows to be shown.
Link copied to clipboard
open fun setCameraPosition(@NonNull cameraPosition: CameraPosition)
Repositions the camera according to the cameraPosition.
Link copied to clipboard
open fun setDebugActive(debugActive: Boolean)
Changes whether the map debug information is shown.
Link copied to clipboard
open fun setFocalBearing(bearing: Double, focalX: Float, focalY: Float, duration: Long)
Transform the map bearing given a bearing, focal point coordinates, and a duration.
Link copied to clipboard
open fun setGesturesManager(@NonNull androidGesturesManager: AndroidGesturesManager, attachDefaultListeners: Boolean, setDefaultMutuallyExclusives: Boolean)
Sets a custom AndroidGesturesManager to handle android.view.MotionEvents registered by the MapView.
Link copied to clipboard
open fun setInfoWindowAdapter(@Nullable infoWindowAdapter: MapLibreMap.InfoWindowAdapter)
Sets a custom renderer for the contents of info window.
Link copied to clipboard
open fun setLatLngBoundsForCameraTarget(@Nullable latLngBounds: LatLngBounds)
Sets a LatLngBounds that constraints map transformations to this bounds.
Link copied to clipboard
open fun setMaxPitchPreference(@FloatRange(from = MapLibreConstants.MINIMUM_PITCH, to = MapLibreConstants.MAXIMUM_PITCH) maxPitch: Double)
Sets the maximum Pitch the map can be displayed at.
Link copied to clipboard
open fun setMaxZoomPreference(@FloatRange(from = MapLibreConstants.MINIMUM_ZOOM, to = MapLibreConstants.MAXIMUM_ZOOM) maxZoom: Double)
Sets the maximum zoom level the map can be displayed at.
Link copied to clipboard
open fun setMinPitchPreference(@FloatRange(from = MapLibreConstants.MINIMUM_PITCH, to = MapLibreConstants.MAXIMUM_PITCH) minPitch: Double)
Sets the minimum Pitch the map can be displayed at.
Link copied to clipboard
open fun setMinZoomPreference(@FloatRange(from = MapLibreConstants.MINIMUM_ZOOM, to = MapLibreConstants.MAXIMUM_ZOOM) minZoom: Double)
Sets the minimum zoom level the map can be displayed at.
Link copied to clipboard
open fun setOfflineRegionDefinition(@NonNull definition: OfflineRegionDefinition)
open fun setOfflineRegionDefinition(@NonNull definition: OfflineRegionDefinition, @Nullable callback: Style.OnStyleLoaded)
Loads a new style from the specified offline region definition and moves the map camera to that region.
Link copied to clipboard
open fun setOnFpsChangedListener(@Nullable listener: MapLibreMap.OnFpsChangedListener)
Sets a callback that's invoked on every frame rendered to the map view.
Link copied to clipboard
open fun setOnInfoWindowClickListener(@Nullable listener: MapLibreMap.OnInfoWindowClickListener)
Sets a callback that's invoked when the user clicks on an info window.
Link copied to clipboard
open fun setOnInfoWindowCloseListener(@Nullable listener: MapLibreMap.OnInfoWindowCloseListener)
Set an callback to be invoked when an InfoWindow closes.
Link copied to clipboard
open fun setOnInfoWindowLongClickListener(@Nullable listener: MapLibreMap.OnInfoWindowLongClickListener)
Sets a callback that's invoked when a marker's info window is long pressed.
Link copied to clipboard
open fun setOnMarkerClickListener(@Nullable listener: MapLibreMap.OnMarkerClickListener)
Sets a callback that's invoked when the user clicks on a marker.
Link copied to clipboard
open fun setOnPolygonClickListener(@Nullable listener: MapLibreMap.OnPolygonClickListener)
Sets a callback that's invoked when the user clicks on a polygon.
Link copied to clipboard
open fun setOnPolylineClickListener(@Nullable listener: MapLibreMap.OnPolylineClickListener)
Sets a callback that's invoked when the user clicks on a polyline.
Link copied to clipboard
open fun setPadding(left: Int, top: Int, right: Int, bottom: Int)
Sets the distance from the edges of the map view's frame to the edges of the map view's logical viewport.
Link copied to clipboard
open fun setPrefetchesTiles(enable: Boolean)
Enable or disable tile pre-fetching.
Link copied to clipboard
open fun setPrefetchZoomDelta(@IntRange(from = 0) delta: Int)
Set the tile pre-fetching zoom delta.
Link copied to clipboard
open fun setStyle(style: String)
open fun setStyle(style: String, callback: Style.OnStyleLoaded)
Loads a new map style from the specified bundled style.
open fun setStyle(builder: Style.Builder)
open fun setStyle(builder: Style.Builder, callback: Style.OnStyleLoaded)
Loads a new map style from the specified builder.
Link copied to clipboard
open fun setSwapBehaviorFlush(flush: Boolean)
Link copied to clipboard
open fun setTileCacheEnabled(enabled: Boolean)
Indicating whether the map may cache tiles for different zoom levels or not.
Link copied to clipboard
open fun setZoom(zoom: Double, @NonNull focalPoint: PointF, duration: Long)
Zooms the camera to the specified level.
Link copied to clipboard
open fun snapshot(@NonNull callback: MapLibreMap.SnapshotReadyCallback)
Takes a snapshot of the map.
Link copied to clipboard
open fun triggerRepaint()
Trigger the mapview to repaint.
Link copied to clipboard
open fun updateMarker(@NonNull updatedMarker: Marker)
Updates a marker on this map.
Link copied to clipboard
open fun updatePolygon(@NonNull polygon: Polygon)
Update a polygon on this map.
Link copied to clipboard
open fun updatePolyline(@NonNull polyline: Polyline)
Update a polyline on this map.