MapboxMap (MapboxGLAndroidSDK 4.1.0 API)

java.lang.Object
- com.mapbox.mapboxsdk.maps.MapboxMap

```
public class MapboxMap
extends java.lang.Object
```
The general class to interact with in the Android Mapbox SDK. It exposes the entry point for all methods related to the MapView. You cannot instantiate MapboxMap 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 MapboxMap should only be read and modified from the main thread.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MapboxMap.CancelableCallback` Interface definition for a callback to be invoked when a task is complete or cancelled.
`static interface`	`MapboxMap.InfoWindowAdapter` Interface definition for a callback to be invoked when an info window will be shown.
`static class`	`MapboxMap.MarkerViewAdapter<U extends MarkerView>` Interface definition for a callback to be invoked when an MarkerView will be shown.
`static interface`	`MapboxMap.OnCameraChangeListener` Interface definition for a callback to be invoked when the camera changes position.
`static interface`	`MapboxMap.OnFlingListener` Interface definition for a callback to be invoked when the map is flinged.
`static interface`	`MapboxMap.OnFpsChangedListener` Interface definition for a callback to be invoked when a frame is rendered to the map view.
`static interface`	`MapboxMap.OnInfoWindowClickListener` Interface definition for a callback to be invoked when the user clicks on an info window.
`static interface`	`MapboxMap.OnInfoWindowCloseListener` Interface definition for a callback to be invoked when a marker's info window is closed.
`static interface`	`MapboxMap.OnInfoWindowLongClickListener` Interface definition for a callback to be invoked when the user long presses on a marker's info window.
`static interface`	`MapboxMap.OnMapClickListener` Interface definition for a callback to be invoked when the user clicks on the map view.
`static interface`	`MapboxMap.OnMapLongClickListener` Interface definition for a callback to be invoked when the user long clicks on the map view.
`static interface`	`MapboxMap.OnMarkerClickListener` Interface definition for a callback to be invoked when the user clicks on a marker.
`static interface`	`MapboxMap.OnMarkerViewClickListener` Interface definition for a callback to be invoked when the user clicks on a MarkerView.
`static interface`	`MapboxMap.OnMyBearingTrackingModeChangeListener` Interface definition for a callback to be invoked when the the My Location tracking mode changes.
`static interface`	`MapboxMap.OnMyLocationChangeListener` Interface definition for a callback to be invoked when the the My Location view changes location.
`static interface`	`MapboxMap.OnMyLocationTrackingModeChangeListener` Interface definition for a callback to be invoked when the the My Location tracking mode changes.
`static interface`	`MapboxMap.OnScrollListener` Interface definition for a callback to be invoked when the map is scrolled.
`static interface`	`MapboxMap.SnapshotReadyCallback` Interface definition for a callback to be invoked when the snapshot has been taken.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCustomLayer(CustomLayer customLayer, java.lang.String before)` Do not use this method, experimental feature.
`Marker`	`addMarker(BaseMarkerOptions markerOptions)` Adds a marker to this map.
`MarkerView`	`addMarker(BaseMarkerViewOptions markerOptions)` Adds a marker to this map.
`Marker`	`addMarker(MarkerOptions markerOptions)` Adds a marker to this map.
`java.util.List<Marker>`	`addMarkers(java.util.List<? extends BaseMarkerOptions> markerOptionsList)` Adds multiple markers to this map.
`Polygon`	`addPolygon(PolygonOptions polygonOptions)` Adds a polygon to this map.
`java.util.List<Polygon>`	`addPolygons(java.util.List<PolygonOptions> polygonOptionsList)` Adds multiple polygons to this map.
`Polyline`	`addPolyline(PolylineOptions polylineOptions)` Adds a polyline to this map.
`java.util.List<Polyline>`	`addPolylines(java.util.List<PolylineOptions> polylineOptionsList)` Adds multiple polylines to this map.
`void`	`animateCamera(CameraUpdate update)` Animate the camera to a new location defined within `CameraUpdate` using a transition animation that evokes powered flight.
`void`	`animateCamera(CameraUpdate update, int durationMs)` Animate the camera to a new location defined within `CameraUpdate` using a transition animation that evokes powered flight.
`void`	`animateCamera(CameraUpdate update, int durationMs, MapboxMap.CancelableCallback callback)` Animate the camera to a new location defined within `CameraUpdate` using a transition animation that evokes powered flight.
`void`	`animateCamera(CameraUpdate update, MapboxMap.CancelableCallback callback)` Animate the camera to a new location defined within `CameraUpdate` using a transition animation that evokes powered flight.
`void`	`clear()` Removes all markers, polylines, polygons, overlays, etc from the map.
`void`	`cycleDebugOptions()` Cycles through the map debug options.
`void`	`deselectMarker(Marker marker)` Deselects a currently selected marker.
`void`	`deselectMarkers()` Deselects any currently selected marker.
`void`	`easeCamera(CameraUpdate update)` Gradually move the camera by the default duration, zoom will not be affected unless specified within `CameraUpdate`.
`void`	`easeCamera(CameraUpdate update, int durationMs)` Gradually move the camera by a specified duration in milliseconds, zoom will not be affected unless specified within `CameraUpdate`.
`void`	`easeCamera(CameraUpdate update, int durationMs, boolean easingInterpolator)`
`void`	`easeCamera(CameraUpdate update, int durationMs, boolean easingInterpolator, MapboxMap.CancelableCallback callback)`
`void`	`easeCamera(CameraUpdate update, int durationMs, MapboxMap.CancelableCallback callback)` Gradually move the camera by a specified duration in milliseconds, zoom will not be affected unless specified within `CameraUpdate`.
`java.lang.String`	`getAccessToken()` Deprecated. As of release 4.1.0, replaced by `MapboxAccountManager.getAccessToken()`
`Annotation`	`getAnnotation(long id)` Return a annotation based on its id.
`java.util.List<Annotation>`	`getAnnotations()` Returns a list of all the annotations on the map.
`CameraPosition`	`getCameraPosition()` Gets the current position of the camera.
`MapboxMap.InfoWindowAdapter`	`getInfoWindowAdapter()` Gets the callback to be invoked when an info window will be shown.
`java.util.List<Marker>`	`getMarkers()` Returns a list of all the markers on the map.
`MarkerViewManager`	`getMarkerViewManager()` Get the MarkerViewManager associated to the MapView.
`double`	`getMaxZoom()` Gets the maximum zoom level the map can be displayed at.
`double`	`getMinZoom()` Gets the maximum zoom level the map can be displayed at.
`android.location.Location`	`getMyLocation()` Returns the currently displayed user location, or null if there is no location data available.
`MyLocationViewSettings`	`getMyLocationViewSettings()` Gets the settings of the user location for the map.
`MapboxMap.OnInfoWindowClickListener`	`getOnInfoWindowClickListener()` Return the InfoWindow click listener
`MapboxMap.OnInfoWindowCloseListener`	`getOnInfoWindowCloseListener()` Return the InfoWindow close listener
`MapboxMap.OnInfoWindowLongClickListener`	`getOnInfoWindowLongClickListener()` Return the InfoWindow long click listener
`int[]`	`getPadding()` Returns the current configured content padding on map view.
`java.util.List<Polygon>`	`getPolygons()` Returns a list of all the polygons on the map.
`java.util.List<Polyline>`	`getPolylines()` Returns a list of all the polylines on the map.
`Projection`	`getProjection()` Get the Projection object that you can use to convert between screen coordinates and latitude/longitude coordinates.
`java.util.List<Marker>`	`getSelectedMarkers()` Gets the currently selected marker.
`java.lang.String`	`getStyleUrl()` Returns the map style currently displayed in the map view.
`TrackingSettings`	`getTrackingSettings()` Gets the tracking interface settings for the map.
`UiSettings`	`getUiSettings()` Gets the user interface settings for the map.
`void`	`invalidate()` Triggers an invalidation of the map view.
`void`	`invalidateCustomLayers()` Do not use this method, experimental feature.
`boolean`	`isAllowConcurrentMultipleOpenInfoWindows()` Returns whether the map allows concurrent multiple infowindows to be shown.
`boolean`	`isDebugActive()` Returns whether the map debug information is currently shown.
`boolean`	`isMyLocationEnabled()` Returns the status of the my-location layer.
`void`	`moveCamera(CameraUpdate update)` Repositions the camera according to the instructions defined in the update.
`void`	`moveCamera(CameraUpdate update, MapboxMap.CancelableCallback callback)` Repositions the camera according to the instructions defined in the update.
`void`	`removeAnnotation(Annotation annotation)` Removes an annotation from the map.
`void`	`removeAnnotation(long id)` Removes an annotation from the map
`void`	`removeAnnotations()` Removes all annotations from the map.
`void`	`removeAnnotations(java.util.List<? extends Annotation> annotationList)` Removes multiple annotations from the map.
`void`	`removeCustomLayer(java.lang.String id)` Do not use this method, experimental feature.
`void`	`removeMarker(Marker marker)` Convenience method for removing a Marker from the map.
`void`	`removePolygon(Polygon polygon)` Convenience method for removing a Polygon from the map.
`void`	`removePolyline(Polyline polyline)` Convenience method for removing a Polyline from the map.
`void`	`resetNorth()` Resets the map view to face north.
`void`	`selectMarker(Marker marker)` Selects a marker.
`void`	`setAccessToken(java.lang.String accessToken)` Deprecated. As of release 4.1.0, replaced by `MapboxAccountManager.start(Context, String)`
`void`	`setAllowConcurrentMultipleOpenInfoWindows(boolean allow)` Changes whether the map allows concurrent multiple infowindows to be shown.
`void`	`setCameraPosition(CameraPosition cameraPosition)` Repositions the camera according to the cameraPosition.
`void`	`setDebugActive(boolean debugActive)` Changes whether the map debug information is shown.
`void`	`setInfoWindowAdapter(MapboxMap.InfoWindowAdapter infoWindowAdapter)` Sets a custom renderer for the contents of info window.
`void`	`setMaxZoom(double maxZoom)` Sets the maximum zoom level the map can be displayed at.
`void`	`setMinZoom(double minZoom)` Sets the minimum zoom level the map can be displayed at.
`void`	`setMyLocationEnabled(boolean enabled)` Enables or disables the my-location layer.
`void`	`setOnCameraChangeListener(MapboxMap.OnCameraChangeListener listener)` Sets a callback that's invoked on every change in camera position.
`void`	`setOnFlingListener(MapboxMap.OnFlingListener listener)` Sets a callback that's invoked when the map is flinged.
`void`	`setOnFpsChangedListener(MapboxMap.OnFpsChangedListener listener)` Sets a callback that's invoked on every frame rendered to the map view.
`void`	`setOnInfoWindowClickListener(MapboxMap.OnInfoWindowClickListener listener)` Sets a callback that's invoked when the user clicks on an info window.
`void`	`setOnInfoWindowCloseListener(MapboxMap.OnInfoWindowCloseListener listener)`
`void`	`setOnInfoWindowLongClickListener(MapboxMap.OnInfoWindowLongClickListener listener)` Sets a callback that's invoked when a marker's info window is long pressed.
`void`	`setOnMapClickListener(MapboxMap.OnMapClickListener listener)` Sets a callback that's invoked when the user clicks on the map view.
`void`	`setOnMapLongClickListener(MapboxMap.OnMapLongClickListener listener)` Sets a callback that's invoked when the user long clicks on the map view.
`void`	`setOnMarkerClickListener(MapboxMap.OnMarkerClickListener listener)` Sets a callback that's invoked when the user clicks on a marker.
`void`	`setOnMyBearingTrackingModeChangeListener(MapboxMap.OnMyBearingTrackingModeChangeListener listener)` Sets a callback that's invoked when the bearing tracking mode changes.
`void`	`setOnMyLocationChangeListener(MapboxMap.OnMyLocationChangeListener listener)` Sets a callback that's invoked when the the My Location view (which signifies the user's location) changes location.
`void`	`setOnMyLocationTrackingModeChangeListener(MapboxMap.OnMyLocationTrackingModeChangeListener listener)` Sets a callback that's invoked when the location tracking mode changes.
`void`	`setOnScrollListener(MapboxMap.OnScrollListener listener)` Sets a callback that's invoked when the map is scrolled.
`void`	`setPadding(int left, int top, int right, int bottom)` Sets the distance from the edges of the map view’s frame to the edges of the map view’s logical viewport.
`void`	`setStyle(java.lang.String style)` Deprecated. use `setStyleUrl(String)` instead with versioned url methods from `Style`
`void`	`setStyleUrl(java.lang.String url)` Loads a new map style from the specified URL.
`void`	`snapshot(MapboxMap.SnapshotReadyCallback callback)` Takes a snapshot of the map.
`void`	`snapshot(MapboxMap.SnapshotReadyCallback callback, android.graphics.Bitmap bitmap)` Takes a snapshot of the map.
`void`	`updateMarker(Marker updatedMarker)` Updates a marker on this map.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setMinZoom
```
public void setMinZoom(double minZoom)
```
    Sets the minimum zoom level the map can be displayed at.
    
    Parameters:
    
    minZoom - The new minimum zoom level.
  - getMinZoom
```
public double getMinZoom()
```
    Gets the maximum zoom level the map can be displayed at.
    
    Returns:
    
    The minimum zoom level.
  - setMaxZoom
```
public void setMaxZoom(double maxZoom)
```
    Sets the maximum zoom level the map can be displayed at.
    
    Parameters:
    
    maxZoom - The new maximum zoom level.
  - getMaxZoom
```
public double getMaxZoom()
```
    Gets the maximum zoom level the map can be displayed at.
    
    Returns:
    
    The maximum zoom level.
  - getUiSettings
```
public UiSettings getUiSettings()
```
    Gets the user interface settings for the map.
    
    Returns:
  - getTrackingSettings
```
public TrackingSettings getTrackingSettings()
```
    Gets the tracking interface settings for the map.
    
    Returns:
  - getMyLocationViewSettings
```
public MyLocationViewSettings getMyLocationViewSettings()
```
    Gets the settings of the user location for the map.
  - getProjection
```
public Projection getProjection()
```
    Get the Projection object that you can use to convert between screen coordinates and latitude/longitude coordinates.
  - getCameraPosition
```
public final CameraPosition getCameraPosition()
```
    Gets the current position of the camera. The CameraPosition returned is a snapshot of the current position, and will not automatically update when the camera moves.
    
    Returns:
    
    The current position of the Camera.
  - setCameraPosition
```
public void setCameraPosition(CameraPosition cameraPosition)
```
    Repositions the camera according to the cameraPosition. The move is instantaneous, and a subsequent getCameraPosition() will reflect the new position. See CameraUpdateFactory for a set of updates.
    
    Parameters:
    
    cameraPosition -
  - moveCamera
```
public final void moveCamera(CameraUpdate update)
```
    Repositions the camera according to the instructions defined in the update. The move is instantaneous, and a subsequent getCameraPosition() will reflect the new position. See CameraUpdateFactory for a set of updates.
    
    Parameters:
    
    update - The change that should be applied to the camera.
  - moveCamera
```
public final void moveCamera(CameraUpdate update,
                             MapboxMap.CancelableCallback callback)
```
    Repositions the camera according to the instructions defined in the update. The move is instantaneous, and a subsequent getCameraPosition() will reflect the new position. See CameraUpdateFactory for a set of updates.
    
    Parameters:
    
    update - The change that should be applied to the camera.
  - easeCamera
```
public final void easeCamera(CameraUpdate update)
```
    Gradually move the camera by the default duration, zoom will not be affected unless specified within CameraUpdate. If getCameraPosition() is called during the animation, it will return the current location of the camera in flight.
    
    Parameters:
    
    update - The change that should be applied to the camera.
    
    See Also:
    
    for a set of updates.
  - easeCamera
```
public final void easeCamera(CameraUpdate update,
                             int durationMs)
```
    Gradually move the camera by a specified duration in milliseconds, zoom will not be affected unless specified within CameraUpdate. If getCameraPosition() is called during the animation, it will return the current location of the camera in flight.
    
    Parameters:
    
    update - The change that should be applied to the camera.
    
    durationMs - The duration of the animation in milliseconds. This must be strictly positive, otherwise an IllegalArgumentException will be thrown.
    
    See Also:
    
    for a set of updates.
  - easeCamera
```
public final void easeCamera(CameraUpdate update,
                             int durationMs,
                             MapboxMap.CancelableCallback callback)
```
    Gradually move the camera by a specified duration in milliseconds, zoom will not be affected unless specified within CameraUpdate. A callback can be used to be notified when easing the camera stops. If getCameraPosition() is called during the animation, it will return the current location of the camera in flight.
    
    Parameters:
    
    update - The change that should be applied to the camera.
    
    durationMs - The duration of the animation in milliseconds. This must be strictly positive, otherwise an IllegalArgumentException will be thrown.
    
    callback - An optional callback to be notified from the main thread when the animation stops. If the animation stops due to its natural completion, the callback will be notified with onFinish(). If the animation stops due to interruption by a later camera movement or a user gesture, onCancel() will be called. Do not update or ease the camera from within onCancel().
    
    See Also:
    
    for a set of updates.
  - easeCamera
```
public final void easeCamera(CameraUpdate update,
                             int durationMs,
                             boolean easingInterpolator)
```
  - easeCamera
```
public final void easeCamera(CameraUpdate update,
                             int durationMs,
                             boolean easingInterpolator,
                             MapboxMap.CancelableCallback callback)
```
  - animateCamera
```
public final void animateCamera(CameraUpdate update)
```
    Animate the camera to a new location defined within CameraUpdate using a transition animation that evokes powered flight. The animation will last the default amount of time. During the animation, a call to getCameraPosition() returns an intermediate location of the camera in flight.
    
    Parameters:
    
    update - The change that should be applied to the camera.
    
    See Also:
    
    for a set of updates.
  - animateCamera
```
public final void animateCamera(CameraUpdate update,
                                MapboxMap.CancelableCallback callback)
```
    Animate the camera to a new location defined within CameraUpdate using a transition animation that evokes powered flight. The animation will last the default amount of time. A callback can be used to be notified when animating the camera stops. During the animation, a call to getCameraPosition() returns an intermediate location of the camera in flight.
    
    Parameters:
    
    update - The change that should be applied to the camera.
    
    callback - The callback to invoke from the main thread when the animation stops. If the animation completes normally, onFinish() is called; otherwise, onCancel() is called. Do not update or animate the camera from within onCancel().
    
    See Also:
    
    for a set of updates.
  - animateCamera
```
public final void animateCamera(CameraUpdate update,
                                int durationMs)
```
    Animate the camera to a new location defined within CameraUpdate using a transition animation that evokes powered flight. The animation will last a specified amount of time given in milliseconds. During the animation, a call to getCameraPosition() returns an intermediate location of the camera in flight.
    
    Parameters:
    
    update - The change that should be applied to the camera.
    
    durationMs - The duration of the animation in milliseconds. This must be strictly positive, otherwise an IllegalArgumentException will be thrown.
    
    See Also:
    
    for a set of updates.
  - animateCamera
```
public final void animateCamera(CameraUpdate update,
                                int durationMs,
                                MapboxMap.CancelableCallback callback)
```
    Animate the camera to a new location defined within CameraUpdate using a transition animation that evokes powered flight. The animation will last a specified amount of time given in milliseconds. A callback can be used to be notified when animating the camera stops. During the animation, a call to getCameraPosition() returns an intermediate location of the camera in flight.
    
    Parameters:
    
    update - The change that should be applied to the camera.
    
    durationMs - The duration of the animation in milliseconds. This must be strictly positive, otherwise an IllegalArgumentException will be thrown.
    
    callback - An optional callback to be notified from the main thread when the animation stops. If the animation stops due to its natural completion, the callback will be notified with onFinish(). If the animation stops due to interruption by a later camera movement or a user gesture, onCancel() will be called. Do not update or animate the camera from within onCancel(). If a callback isn't required, leave it as null.
    
    See Also:
    
    for a set of updates.
  - resetNorth
```
public void resetNorth()
```
    Resets the map view to face north.
  - isDebugActive
```
public boolean isDebugActive()
```
    Returns whether the map debug information is currently shown.
    
    Returns:
    
    If true, map debug information is currently shown.
  - setDebugActive
```
public void setDebugActive(boolean debugActive)
```
    Changes whether the map debug information is shown.
    The default value is false.
    
    Parameters:
    
    debugActive - If true, map debug information is shown.
  - cycleDebugOptions
```
public void cycleDebugOptions()
```
    Cycles through the map debug options.
    The value of MapView.isDebugActive() reflects whether there are any map debug options enabled or disabled.
    
    See Also:
    
    MapView.isDebugActive()
  - setStyleUrl
```
public void setStyleUrl(java.lang.String url)
```
    Loads a new map style from the specified URL.
    url can take the following forms:
    - Style.*: load one of the bundled styles in Style.
    - mapbox://styles/<user>/<style>: retrieves 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://...: retrieves the style over the Internet from any web server.
    - asset://...: reads the style from the APK assets/ directory. This is used to load a style bundled with your app.
    - null: loads the default Style.MAPBOX_STREETS style.
    This method is asynchronous and will return immediately before the style finishes loading. If you wish to wait for the map to finish loading listen for the MapView.DID_FINISH_LOADING_MAP event.
    If the style fails to load or an invalid style URL is set, the map view will become blank. An error message will be logged in the Android logcat and MapView.DID_FAIL_LOADING_MAP event will be sent.
    Parameters:
    
    url - The URL of the map style
    
    See Also:
    
    Style
  - setStyle
```
@Deprecated
public void setStyle(java.lang.String style)
```
    Deprecated. use setStyleUrl(String) instead with versioned url methods from Style
    
    Loads a new map style from the specified bundled style.
    
    This method is asynchronous and will return immediately before the style finishes loading. If you wish to wait for the map to finish loading listen for the MapView.DID_FINISH_LOADING_MAP event.
    If the style fails to load or an invalid style URL is set, the map view will become blank. An error message will be logged in the Android logcat and MapView.DID_FAIL_LOADING_MAP event will be sent.
    
    Parameters:
    
    style - The bundled style. Accepts one of the values from Style.
    
    See Also:
    
    Style
  - getStyleUrl
```
public java.lang.String getStyleUrl()
```
    Returns the map style currently displayed in the map view.
    If the default style is currently displayed, a URL will be returned instead of null.
    
    Returns:
    
    The URL of the map style.
  - setAccessToken
```
@Deprecated
public void setAccessToken(java.lang.String accessToken)
```
    Deprecated. As of release 4.1.0, replaced by MapboxAccountManager.start(Context, String)
    
    DEPRECATED @see MapboxAccountManager#start(String)
    
    Sets the current Mapbox access token used to load map styles and tiles.
    
    Parameters:
    
    accessToken - Your public Mapbox access token.
    
    See Also:
    
    MapView.setAccessToken(String)
  - getAccessToken
```
@Deprecated
public java.lang.String getAccessToken()
```
    Deprecated. As of release 4.1.0, replaced by MapboxAccountManager.getAccessToken()
    
    DEPRECATED @see MapboxAccountManager#getAccessToken()
    
    Returns the current Mapbox access token used to load map styles and tiles.
    
    Returns:
    
    The current Mapbox access token.
  - addMarker
```
public Marker addMarker(MarkerOptions markerOptions)
```
    Adds a marker to this map.
    The marker's icon is rendered on the map at the location Marker.position. If Marker.title is defined, the map shows an info box with the marker's title and snippet.
    
    Parameters:
    
    markerOptions - A marker options object that defines how to render the marker.
    
    Returns:
    
    The Marker that was added to the map.
  - addMarker
```
public Marker addMarker(BaseMarkerOptions markerOptions)
```
    Adds a marker to this map.
    The marker's icon is rendered on the map at the location Marker.position. If Marker.title is defined, the map shows an info box with the marker's title and snippet.
    
    Parameters:
    
    markerOptions - A marker options object that defines how to render the marker.
    
    Returns:
    
    The Marker that was added to the map.
  - addMarker
```
public MarkerView addMarker(BaseMarkerViewOptions markerOptions)
```
    Adds a marker to this map.
    The marker's icon is rendered on the map at the location Marker.position. If Marker.title is defined, the map shows an info box with the marker's title and snippet.
    
    Parameters:
    
    markerOptions - A marker options object that defines how to render the marker.
    
    Returns:
    
    The Marker that was added to the map.
  - addMarkers
```
public java.util.List<Marker> addMarkers(java.util.List<? extends BaseMarkerOptions> markerOptionsList)
```
    Adds multiple markers to this map.
    The marker's icon is rendered on the map at the location Marker.position. If Marker.title is defined, the map shows an info box with the marker's title and snippet.
    
    Parameters:
    
    markerOptionsList - A list of marker options objects that defines how to render the markers.
    
    Returns:
    
    A list of the Markers that were added to the map.
  - updateMarker
```
public void updateMarker(Marker updatedMarker)
```
    Updates a marker on this map. Does nothing if the marker is already added.
    
    Parameters:
    
    updatedMarker - An updated marker object.
  - addPolyline
```
public Polyline addPolyline(PolylineOptions polylineOptions)
```
    Adds a polyline to this map.
    
    Parameters:
    
    polylineOptions - A polyline options object that defines how to render the polyline.
    
    Returns:
    
    The Polyine that was added to the map.
  - addPolylines
```
public java.util.List<Polyline> addPolylines(java.util.List<PolylineOptions> polylineOptionsList)
```
    Adds multiple polylines to this map.
    
    Parameters:
    
    polylineOptionsList - A list of polyline options objects that defines how to render the polylines.
    
    Returns:
    
    A list of the Polylines that were added to the map.
  - addPolygon
```
public Polygon addPolygon(PolygonOptions polygonOptions)
```
    Adds a polygon to this map.
    
    Parameters:
    
    polygonOptions - A polygon options object that defines how to render the polygon.
    
    Returns:
    
    The Polygon that was added to the map.
  - addPolygons
```
public java.util.List<Polygon> addPolygons(java.util.List<PolygonOptions> polygonOptionsList)
```
    Adds multiple polygons to this map.
    
    Parameters:
    
    polygonOptionsList - A list of polygon options objects that defines how to render the polygons.
    
    Returns:
    
    A list of the Polygons that were added to the map.
  - removeMarker
```
public void removeMarker(Marker marker)
```
    Convenience method for removing a Marker from the map.
    Calls removeAnnotation() internally
    
    Parameters:
    
    marker - Marker to remove
  - removePolyline
```
public void removePolyline(Polyline polyline)
```
    Convenience method for removing a Polyline from the map.
    Calls removeAnnotation() internally
    
    Parameters:
    
    polyline - Polyline to remove
  - removePolygon
```
public void removePolygon(Polygon polygon)
```
    Convenience method for removing a Polygon from the map.
    Calls removeAnnotation() internally
    
    Parameters:
    
    polygon - Polygon to remove
  - removeAnnotation
```
public void removeAnnotation(Annotation annotation)
```
    Removes an annotation from the map.
    
    Parameters:
    
    annotation - The annotation object to remove.
  - removeAnnotation
```
public void removeAnnotation(long id)
```
    Removes an annotation from the map
    
    Parameters:
    
    id - The identifier associated to the annotation to be removed
  - removeAnnotations
```
public void removeAnnotations(java.util.List<? extends Annotation> annotationList)
```
    Removes multiple annotations from the map.
    
    Parameters:
    
    annotationList - A list of annotation objects to remove.
  - removeAnnotations
```
public void removeAnnotations()
```
    Removes all annotations from the map.
  - clear
```
public void clear()
```
    Removes all markers, polylines, polygons, overlays, etc from the map.
  - getAnnotation
```
public Annotation getAnnotation(long id)
```
    Return a annotation based on its id.
    
    Returns:
    
    An annotation with a matched id, null is returned if no match was found.
  - getAnnotations
```
public java.util.List<Annotation> getAnnotations()
```
    Returns a list of all the annotations on the map.
    
    Returns:
    
    A list of all the annotation objects. The returned object is a copy so modifying this list will not update the map.
  - getMarkers
```
public java.util.List<Marker> getMarkers()
```
    Returns a list of all the markers on the map.
    
    Returns:
    
    A list of all the markers objects. The returned object is a copy so modifying this list will not update the map.
  - getPolygons
```
public java.util.List<Polygon> getPolygons()
```
    Returns a list of all the polygons on the map.
    
    Returns:
    
    A list of all the polygon objects. The returned object is a copy so modifying this list will not update the map.
  - getPolylines
```
public java.util.List<Polyline> getPolylines()
```
    Returns a list of all the polylines on the map.
    
    Returns:
    
    A list of all the polylines objects. The returned object is a copy so modifying this list will not update the map.
  - selectMarker
```
public void selectMarker(Marker marker)
```
    Selects a marker. The selected marker will have it's info window opened. Any other open info windows will be closed unless isAllowConcurrentMultipleOpenInfoWindows() is true.
    Selecting an already selected marker will have no effect.
    
    Parameters:
    
    marker - The marker to select.
  - deselectMarkers
```
public void deselectMarkers()
```
    Deselects any currently selected marker. All markers will have it's info window closed.
  - deselectMarker
```
public void deselectMarker(Marker marker)
```
    Deselects a currently selected marker. The selected marker will have it's info window closed.
  - getSelectedMarkers
```
public java.util.List<Marker> getSelectedMarkers()
```
    Gets the currently selected marker.
    
    Returns:
    
    The currently selected marker.
  - getMarkerViewManager
```
public MarkerViewManager getMarkerViewManager()
```
    Get the MarkerViewManager associated to the MapView.
    
    Returns:
    
    the associated MarkerViewManager
  - setInfoWindowAdapter
```
public void setInfoWindowAdapter(MapboxMap.InfoWindowAdapter infoWindowAdapter)
```
    Sets a custom renderer for the contents of info window.
    When set your callback is invoked when an info window is about to be shown. By returning a custom View, the default info window will be replaced.
    
    Parameters:
    
    infoWindowAdapter - The callback to be invoked when an info window will be shown. To unset the callback, use null.
  - getInfoWindowAdapter
```
public MapboxMap.InfoWindowAdapter getInfoWindowAdapter()
```
    Gets the callback to be invoked when an info window will be shown.
    
    Returns:
    
    The callback to be invoked when an info window will be shown.
  - setAllowConcurrentMultipleOpenInfoWindows
```
public void setAllowConcurrentMultipleOpenInfoWindows(boolean allow)
```
    Changes whether the map allows concurrent multiple infowindows to be shown.
    
    Parameters:
    
    allow - If true, map allows concurrent multiple infowindows to be shown.
  - isAllowConcurrentMultipleOpenInfoWindows
```
public boolean isAllowConcurrentMultipleOpenInfoWindows()
```
    Returns whether the map allows concurrent multiple infowindows to be shown.
    
    Returns:
    
    If true, map allows concurrent multiple infowindows to be shown.
  - setPadding
```
public void setPadding(int left,
                       int top,
                       int right,
                       int bottom)
```
    Sets the distance from the edges of the map view’s frame to the edges of the map view’s logical viewport.
    
    When the value of this property is equal to {0,0,0,0}, viewport properties such as `centerCoordinate` assume a viewport that matches the map view’s frame. Otherwise, those properties are inset, excluding part of the frame from the viewport. For instance, if the only the top edge is inset, the map center is effectively shifted downward.
    
    Parameters:
    
    left - The left margin in pixels.
    
    top - The top margin in pixels.
    
    right - The right margin in pixels.
    
    bottom - The bottom margin in pixels.
  - getPadding
```
public int[] getPadding()
```
    Returns the current configured content padding on map view.
    
    Returns:
    
    An array with length 4 in the LTRB order.
  - setOnCameraChangeListener
```
public void setOnCameraChangeListener(MapboxMap.OnCameraChangeListener listener)
```
    Sets a callback that's invoked on every change in camera position.
    
    Parameters:
    
    listener - The callback that's invoked on every camera change position. To unset the callback, use null.
  - setOnFpsChangedListener
```
public void setOnFpsChangedListener(MapboxMap.OnFpsChangedListener listener)
```
    Sets a callback that's invoked on every frame rendered to the map view.
    
    Parameters:
    
    listener - The callback that's invoked on every frame rendered to the map view. To unset the callback, use null.
  - setOnScrollListener
```
public void setOnScrollListener(MapboxMap.OnScrollListener listener)
```
    Sets a callback that's invoked when the map is scrolled.
    
    Parameters:
    
    listener - The callback that's invoked when the map is scrolled. To unset the callback, use null.
  - setOnFlingListener
```
public void setOnFlingListener(MapboxMap.OnFlingListener listener)
```
    Sets a callback that's invoked when the map is flinged.
    
    Parameters:
    
    listener - The callback that's invoked when the map is flinged. To unset the callback, use null.
  - setOnMapClickListener
```
public void setOnMapClickListener(MapboxMap.OnMapClickListener listener)
```
    Sets a callback that's invoked when the user clicks on the map view.
    
    Parameters:
    
    listener - The callback that's invoked when the user clicks on the map view. To unset the callback, use null.
  - setOnMapLongClickListener
```
public void setOnMapLongClickListener(MapboxMap.OnMapLongClickListener listener)
```
    Sets a callback that's invoked when the user long clicks on the map view.
    
    Parameters:
    
    listener - The callback that's invoked when the user long clicks on the map view. To unset the callback, use null.
  - setOnMarkerClickListener
```
public void setOnMarkerClickListener(MapboxMap.OnMarkerClickListener listener)
```
    Sets a callback that's invoked when the user clicks on a marker.
    
    Parameters:
    
    listener - The callback that's invoked when the user clicks on a marker. To unset the callback, use null.
  - setOnInfoWindowClickListener
```
public void setOnInfoWindowClickListener(MapboxMap.OnInfoWindowClickListener listener)
```
    Sets a callback that's invoked when the user clicks on an info window.
    
    Parameters:
    
    listener - The callback that's invoked when the user clicks on an info window. To unset the callback, use null.
  - getOnInfoWindowClickListener
```
public MapboxMap.OnInfoWindowClickListener getOnInfoWindowClickListener()
```
    Return the InfoWindow click listener
    
    Returns:
    
    Current active InfoWindow Click Listener
  - setOnInfoWindowLongClickListener
```
public void setOnInfoWindowLongClickListener(MapboxMap.OnInfoWindowLongClickListener listener)
```
    Sets a callback that's invoked when a marker's info window is long pressed.
    
    Parameters:
    
    listener - The callback that's invoked when a marker's info window is long pressed. To unset the callback, use null.
  - getOnInfoWindowLongClickListener
```
public MapboxMap.OnInfoWindowLongClickListener getOnInfoWindowLongClickListener()
```
    Return the InfoWindow long click listener
    
    Returns:
    
    Current active InfoWindow long Click Listener
  - setOnInfoWindowCloseListener
```
public void setOnInfoWindowCloseListener(MapboxMap.OnInfoWindowCloseListener listener)
```
  - getOnInfoWindowCloseListener
```
public MapboxMap.OnInfoWindowCloseListener getOnInfoWindowCloseListener()
```
    Return the InfoWindow close listener
    
    Returns:
    
    Current active InfoWindow Close Listener
  - isMyLocationEnabled
```
public boolean isMyLocationEnabled()
```
    Returns the status of the my-location layer.
    
    Returns:
    
    True if the my-location layer is enabled, false otherwise.
  - setMyLocationEnabled
```
public void setMyLocationEnabled(boolean enabled)
```
    Enables or disables the my-location layer. While enabled, the my-location layer continuously draws an indication of a user's current location and bearing.
    In order to use the my-location layer feature you need to request permission for either Manifest.permission.ACCESS_COARSE_LOCATION or @link android.Manifest.permission#ACCESS_FINE_LOCATION.
    
    Parameters:
    
    enabled - True to enable; false to disable.
  - getMyLocation
```
public android.location.Location getMyLocation()
```
    Returns the currently displayed user location, or null if there is no location data available.
    
    Returns:
    
    The currently displayed user location.
  - setOnMyLocationChangeListener
```
public void setOnMyLocationChangeListener(MapboxMap.OnMyLocationChangeListener listener)
```
    Sets a callback that's invoked when the the My Location view (which signifies the user's location) changes location.
    
    Parameters:
    
    listener - The callback that's invoked when the user clicks on a marker. To unset the callback, use null.
  - setOnMyLocationTrackingModeChangeListener
```
public void setOnMyLocationTrackingModeChangeListener(MapboxMap.OnMyLocationTrackingModeChangeListener listener)
```
    Sets a callback that's invoked when the location tracking mode changes.
    
    Parameters:
    
    listener - The callback that's invoked when the location tracking mode changes. To unset the callback, use null.
  - setOnMyBearingTrackingModeChangeListener
```
public void setOnMyBearingTrackingModeChangeListener(MapboxMap.OnMyBearingTrackingModeChangeListener listener)
```
    Sets a callback that's invoked when the bearing tracking mode changes.
    
    Parameters:
    
    listener - The callback that's invoked when the bearing tracking mode changes. To unset the callback, use null.
  - addCustomLayer
```
public void addCustomLayer(CustomLayer customLayer,
                           java.lang.String before)
```
    Do not use this method, experimental feature.
  - removeCustomLayer
```
public void removeCustomLayer(java.lang.String id)
```
    Do not use this method, experimental feature.
  - invalidateCustomLayers
```
public void invalidateCustomLayers()
```
    Do not use this method, experimental feature.
  - invalidate
```
public void invalidate()
```
    Triggers an invalidation of the map view.
  - snapshot
```
public void snapshot(MapboxMap.SnapshotReadyCallback callback,
                     android.graphics.Bitmap bitmap)
```
    Takes a snapshot of the map.
    
    Parameters:
    
    callback - Callback method invoked when the snapshot is taken.
    
    bitmap - A pre-allocated bitmap.
  - snapshot
```
public void snapshot(MapboxMap.SnapshotReadyCallback callback)
```
    Takes a snapshot of the map.
    
    Parameters:
    
    callback - Callback method invoked when the snapshot is taken.

Class MapboxMap

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setMinZoom

getMinZoom

setMaxZoom

getMaxZoom

getUiSettings

getTrackingSettings

getMyLocationViewSettings

getProjection

getCameraPosition

setCameraPosition

moveCamera

moveCamera

easeCamera

easeCamera

easeCamera

easeCamera

easeCamera

animateCamera

animateCamera

animateCamera

animateCamera

resetNorth

isDebugActive

setDebugActive

cycleDebugOptions

setStyleUrl

setStyle

getStyleUrl

setAccessToken

getAccessToken

addMarker

addMarker

addMarker

addMarkers

updateMarker

addPolyline

addPolylines

addPolygon

addPolygons

removeMarker

removePolyline

removePolygon

removeAnnotation

removeAnnotation

removeAnnotations

removeAnnotations

clear

getAnnotation

getAnnotations

getMarkers

getPolygons

getPolylines

selectMarker

deselectMarkers

deselectMarker

getSelectedMarkers

getMarkerViewManager

setInfoWindowAdapter

getInfoWindowAdapter

setAllowConcurrentMultipleOpenInfoWindows

isAllowConcurrentMultipleOpenInfoWindows

setPadding

getPadding

setOnCameraChangeListener

setOnFpsChangedListener

setOnScrollListener

setOnFlingListener

setOnMapClickListener

setOnMapLongClickListener

setOnMarkerClickListener

setOnInfoWindowClickListener

getOnInfoWindowClickListener

setOnInfoWindowLongClickListener

getOnInfoWindowLongClickListener

setOnInfoWindowCloseListener