TomtomMap (Android Maps SDK

All Superinterfaces:

androidx.core.app.ActivityCompat.OnRequestPermissionsResultCallback
```
public interface TomtomMap
extends androidx.core.app.ActivityCompat.OnRequestPermissionsResultCallback
```
Interface that is the main entry point for all methods related to the map. TomtomMap is obtained using the MapFragment.getAsyncMap(OnMapReadyCallback) method on a MapFragment.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addLocationUpdateListener(LocationUpdateListener locationUpdateListener)` Add location update listener.
`Marker`	`addMarker(MarkerBuilder markerBuilder)` Add marker to map.
`void`	`addOnCircleClickListener(TomtomMapCallback.OnCircleClickListener listener)` Called to add a listener for circle clicks.
`void`	`addOnMapChangedListener(TomtomMapCallback.OnMapChangedListener onMapChangedListener)` Set callback interface that is executed when the map status is changed.
`void`	`addOnMapClickListener(TomtomMapCallback.OnMapClickListener listener)` Set callback interface that is executed when the user click on the map.
`void`	`addOnMapLongClickListener(TomtomMapCallback.OnMapLongClickListener listener)` Set callback interface that is executed when the user long click on the map.
`void`	`addOnMapViewPortChangedListener(TomtomMapCallback.OnMapViewPortChanged onMapViewPortChangedListener)` Set callback interface that is executed when the map view port is changed.
`void`	`addOnMarkerClickListener(TomtomMapCallback.OnMarkerClickListener listener)` Called to add a listener for marker clicks.
`void`	`addOnMarkerDragListener(TomtomMapCallback.OnMarkerDragListener listener)` Called to add a listener for marker dragging.
`void`	`addOnPolygonClickListener(TomtomMapCallback.OnPolygonClickListener listener)` Called to add a listener for polygon clicks.
`void`	`addOnPolylineClickListener(TomtomMapCallback.OnPolylineClickListener listener)` Called to add a listener for polygon clicks.
`void`	`addOnRouteClickListener(TomtomMapCallback.OnRouteClickListener listener)` Called to add a listener for route clicks.
`Route`	`addRoute(RouteBuilder routeBuilder)` Display route and prepare map to navigate on that route.
`com.tomtom.online.sdk.matching.MatchingDataProvider`	`asMatchingDataProvider()` Convert tomtomMap to matching data provider representation.
`void`	`bringRouteToFront(long routeId)` Bring the specific route to front.
`void`	`centerOn(CameraPosition cameraPosition)` Center map on using given camera position options.
`void`	`centerOn(double latitude, double longitude)` Center map on given latitude and longitude.
`void`	`centerOn(double latitude, double longitude, double zoomLevel)` Center map on given latitude and longitude with a given zoom level.
`void`	`centerOn(double latitude, double longitude, double zoomLevel, int yawAngle)` Center map on given latitude and longitude with a given zoom level and yaw angle (map rotation).
`void`	`centerOn(LatLng location)` Center map on given coordinates/
`void`	`centerOn(LatLng location, double zoomLevel)` Center map on given coordinates and with given zoom level.
`void`	`centerOnMyLocation()` Center map on current location.
`void`	`centerOnMyLocationWithNorthUp()` Center map on current location and set map orientation to north.
`void`	`centerOnWithDefaultZoom(double latitude, double longitude)` Center map on given latitude and longitude with default zoom level .
`void`	`clear()` Clear from map all annotation, like markers, polyline, polygon's, routes or chevrons.
`void`	`clearRoute()` Erase route from map.
`void`	`collectLogsToFile(java.lang.String fileName)` Collect logs from logcat to file.
`void`	`displayRouteOverview(long id)` Display route overview using its id.
`void`	`displayRoutesOverview()` Display route overview.
`Optional<Marker>`	`findMarkerByID(long id)` Find marker using its id.
`Optional<Marker>`	`findMarkerByPosition(LatLng location)` Find marker using its location (latitude, longitude).
`Optional<Marker>`	`findMarkerByTag(java.io.Serializable tag)` Find marker using its tag.
`Optional<Route>`	`findRouteByID(long id)` Find route using its id.
`LatLng`	`getCenterOfMap()` Latitude and longitude of map center.
`com.tomtom.online.sdk.common.location.BoundingBox`	`getCurrentBounds()` Gets current region bounds.
`LocationSource`	`getDefaultLocationSource()` Default location source implementation.
`double`	`getDefaultZoomLevel()` Default zoom level for map.
`DrivingSettings`	`getDrivingSettings()` Advanced settings for driving options manipulation.
`com.tomtom.core.maps.MapGestureDetector`	`getGestureDetector()` Get current gesture detector implementation.
`GesturesDetectionSettings`	`getGesturesDetectionSettings()` Obtains the gestures detection settings object.
`Optional<GpsIndicator>`	`getGpsPositionIndicator()` GPS Position icon indicator.
`LocationSource`	`getLocationSource()` Location source provide information about map location.
`LogoSettings`	`getLogoSettings()` Settings for manipulating logo and copyrights text view.
`java.util.List<Marker>`	`getMarkers()` Get list of all markers added to map.
`MarkerSettings`	`getMarkerSettings()` Advanced settings for markers manipulation.
`com.tomtom.online.sdk.common.callbacks.CallbackContainer<TomtomMapCallback.OnMapChangedListener>`	`getOnMapChangedListener()` Returns assigned map changed interface, null otherwise.
`com.tomtom.online.sdk.common.callbacks.CallbackContainer<TomtomMapCallback.OnMapClickListener>`	`getOnMapClickListener()` Returns assigned map click interface, null otherwise.
`com.tomtom.online.sdk.common.callbacks.CallbackContainer<TomtomMapCallback.OnMapLongClickListener>`	`getOnMapLongClickListener()` Returns assigned map long click interface, null otherwise.
`com.tomtom.online.sdk.common.callbacks.CallbackContainer<TomtomMapCallback.OnMapViewPortChanged>`	`getOnMapViewPortChangedListener()` Returns assigned map view port changed interface, null otherwise.
`OverlaySettings`	`getOverlaySettings()` Overlay is shape or polyline or polygon.
`java.util.List<Route>`	`getRoutes()` Get list of all routs added to the map.
`RouteSettings`	`getRouteSettings()` Advanced settings for displaying route on map.
`StyleSettings`	`getStyleSettings()` Advanced settings for style manipulation (e.g.
`TrafficSettings`	`getTrafficSettings()` Settings for manipulating traffic settings.
`UiSettings`	`getUiSettings()` Settings for manipulating map settings related to UI (e.g.
`android.location.Location`	`getUserLocation()` If location is enabled for map, returns user's location (the same as indicated by GPS dot).
`double`	`getZoomLevel()` getZoomLevel.
`double`	`getZoomLevelForBounds(LatLng topLeft, LatLng bottomRight)` Gets zoom for the minimum region which contains both coordinates.
`boolean`	`is2D()` True if 2D mode is set, false otherwise.
`boolean`	`isMyLocationEnabled()` Gets the status of the my-location layer.
`boolean`	`isUserLocationInMapBoundingBox()` Checks whether user location is inside current map bounding box.
`LatLng`	`latLngForPixel(android.graphics.PointF position)` Convert point on the screen to map position.
`MapLayers`	`layers()` Get settings that allow to manipulate map layers options.
`void`	`moveMapBy(double offsetX, double offsetY, long duration)` Moves the map toward x,y vector in specified time.
`android.graphics.PointF`	`pixelForLatLng(LatLng latLng)` Convert map position on the map to screen position.
`void`	`removeLocationUpdateListener(LocationUpdateListener locationUpdateListener)` Remove location update listener.
`void`	`removeMarker(Marker marker)` Remove selected marker, if added to the map.
`void`	`removeMarkerByID(long id)` Remove marker by marker id.
`void`	`removeMarkerByTag(java.io.Serializable tag)` Remove all markers with tag.
`void`	`removeMarkers()` Remove all markers from the map.
`void`	`removeOnCircleClickListener(TomtomMapCallback.OnCircleClickListener listener)` Called to remove a listener for circle clicks.
`void`	`removeOnCircleClickListeners()` Remove all registered circle click listeners.
`void`	`removeOnMapChangedListener(TomtomMapCallback.OnMapChangedListener listener)` Unregister map changed listener.
`void`	`removeOnMapClickListener(TomtomMapCallback.OnMapClickListener listener)` unregister listener
`void`	`removeOnMapLongClickListener(TomtomMapCallback.OnMapLongClickListener listener)` unregister listener
`void`	`removeOnMapViewPortChangedListener(TomtomMapCallback.OnMapViewPortChanged listener)` unregister listener
`void`	`removeOnMarkerClickListener(TomtomMapCallback.OnMarkerClickListener listener)` Called to remove a listener for marker clicks.
`void`	`removeOnMarkerClickListeners()` Remove all registered marker click listeners.
`void`	`removeOnMarkerDragListener(TomtomMapCallback.OnMarkerDragListener listener)` Called to remove a listener for marker dragging.
`void`	`removeOnMarkerDragListeners()` Remove all registered marker drag listeners.
`void`	`removeOnPolygonClickListener(TomtomMapCallback.OnPolygonClickListener listener)` Called to remove a listener for polygon clicks.
`void`	`removeOnPolygonClickListeners()` Remove all registered polygon click listeners.
`void`	`removeOnPolylineClickListener(TomtomMapCallback.OnPolylineClickListener listener)` Called to remove a listener for polyline clicks.
`void`	`removeOnPolylineClickListeners()` Remove all registered polyline click listeners.
`void`	`removeOnRouteClickListener(TomtomMapCallback.OnRouteClickListener listener)` Called to remove a listener for route clicks.
`void`	`removeOnRouteClickListeners()` Remove all registered route click listeners.
`void`	`set25DMode()` Set 2.5 mode for map.
`void`	`set2DMode()` Set 2d mode for map.
`void`	`set3DMode()` Because our map don't support 3d mode yet, 2.5 mode is set.
`void`	`setCurrentBounds(LatLng topLeft, LatLng bottomRight)` Sets current region as the minimum region which contains both coordinates.
`void`	`setCurrentBounds(java.util.List<LatLng> coordinates)` Sets current region as the minimum region which contains provided coordinates.
`void`	`setGeopoliticalView(java.lang.String geoView)` Set geopolitical view for vector and raster tiles.
`void`	`setGestureDetector(com.tomtom.core.maps.MapGestureDetector mapGestureDetector)` Set custom gesture detector.
`void`	`setGpsPositionIndicator(GpsIndicator gpsPositionIndicator)` Set GPS position indicator.
`void`	`setLanguage(java.lang.String language)` Set language for vector tiles as IETF language tag.
`void`	`setLocationSource(LocationSource locationSource)` Set for map location source.
`void`	`setMyLocationEnabled(boolean enabled)` Enables or disables the my-location layer.
`void`	`setOnMapChangedListener(TomtomMapCallback.OnMapChangedListener onMapChangedListener)` Deprecated.
`void`	`setPadding(double top, double left, double bottom, double right)` Sets padding for the map.
`void`	`setRouteActive(long routeId)` Deprecated.
`void`	`setRouteInactive(long routeId)` Deprecated.
`void`	`setRoutesActive()` Deprecated.
`void`	`setRoutesInactive()` Deprecated.
`MapTiles`	`tiles()` Get settings that allow to manipulate map tiles options.
`com.tomtom.online.sdk.map.TrafficFlowStep`	`trafficFlow()` Get settings that allow to manipulate traffic options.
`com.tomtom.online.sdk.map.TrafficFlowAndIncidentStep`	`trafficFlowAndIncidents()` Get settings that allow to manipulate traffic incident and flow options simultaneously.
`com.tomtom.online.sdk.map.TrafficIncidentsStep`	`trafficIncidents()` Get settings that allow to manipulate traffic incidents options.
`void`	`trafficOff()` Turn off traffic layer.
`void`	`updateGesturesDetectionSettings(GesturesDetectionSettings gesturesDetectionSettings)` Updates the current gestures detection settings.
`void`	`updateRouteStyle(long routeId, RouteStyle routeStyle)` Updates the style of the specific route in terms of route's properties like: width, fillColor and outlineColor.
`void`	`zoomIn()` Zoom map by one level
`void`	`zoomOut()` Zoom out by one level
`void`	`zoomTo(double zoomLevel)` Zoom map to requested level.
`void`	`zoomToAllMarkers()` Zoom map to level where all markers are visible.

Methods inherited from interface androidx.core.app.ActivityCompat.OnRequestPermissionsResultCallback
onRequestPermissionsResult

- Method Detail
  - getUiSettings
```
UiSettings getUiSettings()
```
    Settings for manipulating map settings related to UI (e.g. styling).
  - getTrafficSettings
```
@Beta(year=2019,
      month=9)
TrafficSettings getTrafficSettings()
```
    Settings for manipulating traffic settings.
    
    Returns:
    
    settings
  - getLogoSettings
```
LogoSettings getLogoSettings()
```
    Settings for manipulating logo and copyrights text view.
  - getMarkerSettings
```
MarkerSettings getMarkerSettings()
```
    Advanced settings for markers manipulation.
  - getOverlaySettings
```
OverlaySettings getOverlaySettings()
```
    Overlay is shape or polyline or polygon.
    
    Returns:
    
    object to change settings.
  - getRouteSettings
```
RouteSettings getRouteSettings()
```
    Advanced settings for displaying route on map.
  - getDrivingSettings
```
@Beta(year=2019,
      month=9)
DrivingSettings getDrivingSettings()
```
    Advanced settings for driving options manipulation.
  - getStyleSettings
```
@Beta(year=2019,
      month=12)
StyleSettings getStyleSettings()
```
    Advanced settings for style manipulation (e.g. get layer info or add source in runtime).
  - asMatchingDataProvider
```
@Beta(year=2019,
      month=9)
com.tomtom.online.sdk.matching.MatchingDataProvider asMatchingDataProvider()
```
    Convert tomtomMap to matching data provider representation. Road network is obtained in real-time from map tiles, according to current GPS position.
  - isMyLocationEnabled
```
boolean isMyLocationEnabled()
```
    Gets the status of the my-location layer.
    
    Returns:
    
    true if the my-location layer is enabled; false otherwise.
  - setMyLocationEnabled
```
void setMyLocationEnabled(boolean enabled)
```
    Enables or disables the my-location layer. While enabled and the location is available, the my-location layer continuously draws an indication of a user's current location and bearing, and displays UI controls that allow a user to interact with their location (for example, to enable or disable camera tracking of their location and bearing). In order to use the my-location-layer feature, the SDK request permission for either Manifest.permission#ACCESS_COARSE_LOCATION or Manifest.permission#ACCESS_FINE_LOCATION unless you have set a custom location source.
    
    Parameters:
    
    enabled -
  - getGpsPositionIndicator
```
Optional<GpsIndicator> getGpsPositionIndicator()
```
    GPS Position icon indicator. Visible only when my location is enabled.
  - setGpsPositionIndicator
```
void setGpsPositionIndicator(@NonNull
                             GpsIndicator gpsPositionIndicator)
```
    Set GPS position indicator.
  - setGestureDetector
```
void setGestureDetector(@NonNull
                        com.tomtom.core.maps.MapGestureDetector mapGestureDetector)
```
    Set custom gesture detector. Once the default implementation is overridden, the user can provide their own interpretation of gestures, like tilt, rotate etc.
  - getGestureDetector
```
com.tomtom.core.maps.MapGestureDetector getGestureDetector()
```
    Get current gesture detector implementation.
  - clear
```
void clear()
```
    Clear from map all annotation, like markers, polyline, polygon's, routes or chevrons.
  - setLanguage
```
void setLanguage(@NonNull
                 java.lang.String language)
```
    Set language for vector tiles as IETF language tag. By default, Neutral Ground Truth (NGT) is used.
  - setGeopoliticalView
```
void setGeopoliticalView(@NonNull
                         java.lang.String geoView)
```
    Set geopolitical view for vector and raster tiles. By default, international view is used.
  - getGesturesDetectionSettings
```
@NonNull
GesturesDetectionSettings getGesturesDetectionSettings()
```
    Obtains the gestures detection settings object.
    
    Returns:
    
    gestures detection settings object.
  - updateGesturesDetectionSettings
```
void updateGesturesDetectionSettings(@NonNull
                                     GesturesDetectionSettings gesturesDetectionSettings)
```
    Updates the current gestures detection settings. It allows to enable/disable particular gestures: rotation, zooming and panning.
    
    Parameters:
    
    gesturesDetectionSettings - gestures detection settings update
  - moveMapBy
```
void moveMapBy(double offsetX,
               double offsetY,
               long duration)
```
    Moves the map toward x,y vector in specified time.
    
    Parameters:
    
    offsetX -
    
    offsetY -
    
    duration -
  - latLngForPixel
```
LatLng latLngForPixel(@NonNull
                      android.graphics.PointF position)
```
    Convert point on the screen to map position.
    
    Parameters:
    
    position - of screen.
    
    Returns:
    
    LatLng position point of the screen.
  - pixelForLatLng
```
android.graphics.PointF pixelForLatLng(@NonNull
                                       LatLng latLng)
```
    Convert map position on the map to screen position.
    
    Parameters:
    
    latLng - position on the map.
    
    Returns:
    
    pixel screen position.
  - collectLogsToFile
```
void collectLogsToFile(java.lang.String fileName)
```
    Collect logs from logcat to file. Set log level by LogUtils.enableLogs(int). The best place for set log level is Application.onCreate() method. Android Runtime Permissions handled by this method. When method is called the Android will ask about permissions.
    
    Parameters:
    
    fileName -
  - addRoute
```
Route addRoute(RouteBuilder routeBuilder)
```
    Display route and prepare map to navigate on that route.
  - getRoutes
```
java.util.List<Route> getRoutes()
```
    Get list of all routs added to the map.
  - clearRoute
```
void clearRoute()
```
    Erase route from map.
  - displayRoutesOverview
```
void displayRoutesOverview()
```
    Display route overview. All added routes will be visible.
  - displayRouteOverview
```
void displayRouteOverview(long id)
```
    Display route overview using its id. No action when route not found.
  - findRouteByID
```
Optional<Route> findRouteByID(long id)
```
    Find route using its id.
  - updateRouteStyle
```
void updateRouteStyle(long routeId,
                      RouteStyle routeStyle)
```
    Updates the style of the specific route in terms of route's properties like: width, fillColor and outlineColor.
    
    Parameters:
    
    routeId - the id of the map's route.
    
    routeStyle - the new style for the map's route.
  - bringRouteToFront
```
void bringRouteToFront(long routeId)
```
    Bring the specific route to front. As a result, it will be drawn on top of other routes.
    
    Parameters:
    
    routeId - the id of the map's route.
  - setRoutesInactive
```
@Deprecated
 @DeprecatedSince(month=9,
                 year=2018)
void setRoutesInactive()
```
    Deprecated.
    
    Mark all added routes as inactive. Inactive routes are drawn using gray color. Use RouteExtension.updateRouteStyle(long, RouteStyle) to change route color instead of using this method.
  - setRoutesActive
```
@Deprecated
 @DeprecatedSince(month=9,
                 year=2018)
void setRoutesActive()
```
    Deprecated.
    
    Mark all added routes as active. Active routes are drawn using blue color. Use RouteExtension.updateRouteStyle(long, RouteStyle) to change route color instead of using this method.
  - setRouteActive
```
@Deprecated
 @DeprecatedSince(month=9,
                 year=2018)
void setRouteActive(long routeId)
```
    Deprecated.
    
    Mark route with a given id as active. Active route is drawn using blue color. Use RouteExtension.updateRouteStyle(long, RouteStyle) to change route color instead of using this method. No action if route does not exist.
  - setRouteInactive
```
@Deprecated
 @DeprecatedSince(month=9,
                 year=2018)
void setRouteInactive(long routeId)
```
    Deprecated.
    
    Mark route with a given id as inactive. Inactive route is drawn using gray color. Use RouteExtension.updateRouteStyle(long, RouteStyle) to change route color instead of using this method. No action if route does not exist.
  - addMarker
```
@NonNull
Marker addMarker(MarkerBuilder markerBuilder)
```
    Add marker to map.
    
    Returns:
    
    handle to marker.
  - getMarkers
```
@NonNull
java.util.List<Marker> getMarkers()
```
    Get list of all markers added to map. Even marker which already not visible on map.
    
    Returns:
    
    list of all marker on the map.
  - findMarkerByPosition
```
@NonNull
Optional<Marker> findMarkerByPosition(LatLng location)
```
    Find marker using its location (latitude, longitude).
  - findMarkerByID
```
@NonNull
Optional<Marker> findMarkerByID(long id)
```
    Find marker using its id.
  - findMarkerByTag
```
@NonNull
Optional<Marker> findMarkerByTag(@NonNull
                                          java.io.Serializable tag)
```
    Find marker using its tag.
  - removeMarker
```
void removeMarker(Marker marker)
```
    Remove selected marker, if added to the map.
    
    Parameters:
    
    marker -
  - removeMarkers
```
void removeMarkers()
```
    Remove all markers from the map.
  - removeMarkerByID
```
void removeMarkerByID(long id)
```
    Remove marker by marker id. Because id is unique, method should remove one marker.
  - removeMarkerByTag
```
void removeMarkerByTag(java.io.Serializable tag)
```
    Remove all markers with tag.
  - zoomToAllMarkers
```
void zoomToAllMarkers()
```
    Zoom map to level where all markers are visible.
  - centerOnMyLocation
```
void centerOnMyLocation()
```
    Center map on current location. The current location is obtained using LocationSource.getLastKnownLocation() The default location source is FusedLocationSource, however, it may be overridden by SDK user. No action is executed when last location is null.
  - centerOnMyLocationWithNorthUp
```
void centerOnMyLocationWithNorthUp()
```
    Center map on current location and set map orientation to north. No action is executed when last location is null.
  - centerOn
```
void centerOn(@NonNull
              LatLng location)
```
    Center map on given coordinates/
    
    Parameters:
    
    location - Coordinates to center map on.
  - centerOn
```
void centerOn(@NonNull
              LatLng location,
              double zoomLevel)
```
    Center map on given coordinates and with given zoom level. When zoom level is out of range, the minimum zoom level will be set. Zoom levels are in range [0, 20]
    
    Parameters:
    
    location - Coordinates to center map on.
    
    zoomLevel - Map zoom level
  - centerOn
```
void centerOn(double latitude,
              double longitude)
```
    Center map on given latitude and longitude. Latitude and longitude is set in degrees minutes seconds format.
    
    Parameters:
    
    latitude - Latitude to center map on.
    
    longitude - Longitude to center map on.
  - centerOn
```
void centerOn(double latitude,
              double longitude,
              double zoomLevel)
```
    Center map on given latitude and longitude with a given zoom level. When zoom level is out of range, the minimum zoom level will be set. Zoom levels are in range [0, 20], where 0 is the whole world and 20 is the highest zoom level. Latitude and longitude is set in degrees minutes seconds format.
    
    Parameters:
    
    latitude - Latitude to center map on.
    
    longitude - Longitude to center map on.
    
    zoomLevel - Map zoom level
  - centerOn
```
void centerOn(double latitude,
              double longitude,
              double zoomLevel,
              int yawAngle)
```
    Center map on given latitude and longitude with a given zoom level and yaw angle (map rotation). When zoom level is out of range, the minimum zoom level will be set. Zoom levels are in range [0, 20], where 0 is the whole world and 20 is the highest zoom level. Yaw angle is in range [0, 360], where 0 is north, 90 is east, 180 is south, and 270 is west. Latitude and longitude is set in degrees minutes seconds format.
    
    Parameters:
    
    latitude - Latitude to center map on.
    
    longitude - Longitude to center map on.
    
    zoomLevel - Map zoom level
    
    yawAngle - Map rotation
  - centerOnWithDefaultZoom
```
void centerOnWithDefaultZoom(double latitude,
                             double longitude)
```
    Center map on given latitude and longitude with default zoom level . Latitude and longitude is set in degrees minutes seconds format.
    
    Parameters:
    
    latitude - Latitude to center map on.
    
    longitude - Longitude to center map on.
  - centerOn
```
void centerOn(@NonNull
              CameraPosition cameraPosition)
```
    Center map on using given camera position options. The required parameters for camera position are latitude and logitude (set in degrees minutes seconds format). Zoom, bearing and pitch are not mandatory, will be used once they are set.
    
    Parameters:
    
    cameraPosition - Camera position to center map on.
  - zoomTo
```
void zoomTo(double zoomLevel)
```
    Zoom map to requested level. Zoom levels are in range [0, 20]. Where 0 is whole world. 20 is the highest zoom level.
    
    Parameters:
    
    zoomLevel -
  - zoomIn
```
void zoomIn()
```
    Zoom map by one level
  - zoomOut
```
void zoomOut()
```
    Zoom out by one level
  - getZoomLevel
```
double getZoomLevel()
```
    getZoomLevel.
  - getZoomLevelForBounds
```
double getZoomLevelForBounds(@NonNull
                             LatLng topLeft,
                             @NonNull
                             LatLng bottomRight)
```
    Gets zoom for the minimum region which contains both coordinates.
    
    Parameters:
    
    topLeft - The top left corner of preferred region.
    
    bottomRight - The bottom right corner of preferred region.
  - getCurrentBounds
```
com.tomtom.online.sdk.common.location.BoundingBox getCurrentBounds()
```
    Gets current region bounds.
  - setCurrentBounds
```
void setCurrentBounds(@NonNull
                      LatLng topLeft,
                      @NonNull
                      LatLng bottomRight)
```
    Sets current region as the minimum region which contains both coordinates.
    
    Parameters:
    
    topLeft - The top left corner of preferred region.
    
    bottomRight - The bottom right corner of preferred region.
  - setCurrentBounds
```
void setCurrentBounds(@NonNull
                      java.util.List<LatLng> coordinates)
```
    Sets current region as the minimum region which contains provided coordinates.
    
    Parameters:
    
    coordinates - The coordinates to set bounds for.
  - setPadding
```
void setPadding(double top,
                double left,
                double bottom,
                double right)
```
    Sets padding for the map.
  - getUserLocation
```
@Nullable
android.location.Location getUserLocation()
```
    If location is enabled for map, returns user's location (the same as indicated by GPS dot). If GPS position is not available, this method returns null. It is possible to observe location events using LocationSourceExtension.addLocationUpdateListener(LocationUpdateListener).
    
    Returns:
    
    User current location.
  - getCenterOfMap
```
@NonNull
LatLng getCenterOfMap()
```
    Latitude and longitude of map center.
    
    Returns:
    
    Location of center of map. Chevron and center map location can be different.
  - getDefaultZoomLevel
```
double getDefaultZoomLevel()
```
    Default zoom level for map. See .
    
    Returns:
    
    Default zoom level for map
  - isUserLocationInMapBoundingBox
```
boolean isUserLocationInMapBoundingBox()
```
    Checks whether user location is inside current map bounding box.
    
    Returns:
    
    True if user location is in map bounding box, otherwise false.
  - addOnMapClickListener
```
void addOnMapClickListener(TomtomMapCallback.OnMapClickListener listener)
```
    Set callback interface that is executed when the user click on the map.
  - addOnMapLongClickListener
```
void addOnMapLongClickListener(TomtomMapCallback.OnMapLongClickListener listener)
```
    Set callback interface that is executed when the user long click on the map.
  - addOnMapViewPortChangedListener
```
void addOnMapViewPortChangedListener(TomtomMapCallback.OnMapViewPortChanged onMapViewPortChangedListener)
```
    Set callback interface that is executed when the map view port is changed. It happens when e.g. map is panned or zoomed.
  - setOnMapChangedListener
```
@Deprecated
 @DeprecatedSince(year=2019,
                 month=1)
void setOnMapChangedListener(TomtomMapCallback.OnMapChangedListener onMapChangedListener)
```
    Deprecated.
    
    Set callback interface that is executed when the map status is changed.
  - addOnMapChangedListener
```
void addOnMapChangedListener(TomtomMapCallback.OnMapChangedListener onMapChangedListener)
```
    Set callback interface that is executed when the map status is changed.
  - getOnMapClickListener
```
com.tomtom.online.sdk.common.callbacks.CallbackContainer<TomtomMapCallback.OnMapClickListener> getOnMapClickListener()
```
    Returns assigned map click interface, null otherwise.
  - getOnMapLongClickListener
```
com.tomtom.online.sdk.common.callbacks.CallbackContainer<TomtomMapCallback.OnMapLongClickListener> getOnMapLongClickListener()
```
    Returns assigned map long click interface, null otherwise.
  - getOnMapViewPortChangedListener
```
com.tomtom.online.sdk.common.callbacks.CallbackContainer<TomtomMapCallback.OnMapViewPortChanged> getOnMapViewPortChangedListener()
```
    Returns assigned map view port changed interface, null otherwise.
  - getOnMapChangedListener
```
com.tomtom.online.sdk.common.callbacks.CallbackContainer<TomtomMapCallback.OnMapChangedListener> getOnMapChangedListener()
```
    Returns assigned map changed interface, null otherwise.
  - removeOnMapClickListener
```
void removeOnMapClickListener(TomtomMapCallback.OnMapClickListener listener)
```
    unregister listener
    
    Parameters:
    
    listener -
  - removeOnMapLongClickListener
```
void removeOnMapLongClickListener(TomtomMapCallback.OnMapLongClickListener listener)
```
    unregister listener
    
    Parameters:
    
    listener -
  - removeOnMapViewPortChangedListener
```
void removeOnMapViewPortChangedListener(TomtomMapCallback.OnMapViewPortChanged listener)
```
    unregister listener
    
    Parameters:
    
    listener -
  - removeOnMapChangedListener
```
void removeOnMapChangedListener(TomtomMapCallback.OnMapChangedListener listener)
```
    Unregister map changed listener.
  - set2DMode
```
void set2DMode()
```
    Set 2d mode for map.
  - set25DMode
```
void set25DMode()
```
    Set 2.5 mode for map.
  - set3DMode
```
void set3DMode()
```
    Because our map don't support 3d mode yet, 2.5 mode is set.
  - is2D
```
boolean is2D()
```
    True if 2D mode is set, false otherwise.
  - trafficFlow
```
@NonNull
com.tomtom.online.sdk.map.TrafficFlowStep trafficFlow()
```
    Get settings that allow to manipulate traffic options.
  - trafficIncidents
```
@NonNull
com.tomtom.online.sdk.map.TrafficIncidentsStep trafficIncidents()
```
    Get settings that allow to manipulate traffic incidents options.
  - trafficFlowAndIncidents
```
@NonNull
com.tomtom.online.sdk.map.TrafficFlowAndIncidentStep trafficFlowAndIncidents()
```
    Get settings that allow to manipulate traffic incident and flow options simultaneously.
  - trafficOff
```
void trafficOff()
```
    Turn off traffic layer. Incidents and flow. (Vector and raster type)
  - tiles
```
@NonNull
MapTiles tiles()
```
    Get settings that allow to manipulate map tiles options.
  - layers
```
@NonNull
MapLayers layers()
```
    Get settings that allow to manipulate map layers options.
  - addOnMarkerClickListener
```
void addOnMarkerClickListener(TomtomMapCallback.OnMarkerClickListener listener)
```
    Called to add a listener for marker clicks.
    
    Parameters:
    
    listener - Listener to be added for marker clicks.
  - removeOnMarkerClickListener
```
void removeOnMarkerClickListener(TomtomMapCallback.OnMarkerClickListener listener)
```
    Called to remove a listener for marker clicks.
    
    Parameters:
    
    listener - Listener to be removed for marker clicks.
  - removeOnMarkerClickListeners
```
void removeOnMarkerClickListeners()
```
    Remove all registered marker click listeners.
  - addOnMarkerDragListener
```
void addOnMarkerDragListener(TomtomMapCallback.OnMarkerDragListener listener)
```
    Called to add a listener for marker dragging.
    
    Parameters:
    
    listener - Listener to be added for marker dragging.
  - removeOnMarkerDragListener
```
void removeOnMarkerDragListener(TomtomMapCallback.OnMarkerDragListener listener)
```
    Called to remove a listener for marker dragging.
    
    Parameters:
    
    listener - Listener to be removed for marker dragging.
  - removeOnMarkerDragListeners
```
void removeOnMarkerDragListeners()
```
    Remove all registered marker drag listeners.
  - addOnCircleClickListener
```
void addOnCircleClickListener(TomtomMapCallback.OnCircleClickListener listener)
```
    Called to add a listener for circle clicks.
    
    Parameters:
    
    listener - Listener to be added for circle clicks.
  - removeOnCircleClickListener
```
void removeOnCircleClickListener(TomtomMapCallback.OnCircleClickListener listener)
```
    Called to remove a listener for circle clicks.
    
    Parameters:
    
    listener - Listener to be removed for circle clicks.
  - removeOnCircleClickListeners
```
void removeOnCircleClickListeners()
```
    Remove all registered circle click listeners.
  - addOnPolygonClickListener
```
void addOnPolygonClickListener(TomtomMapCallback.OnPolygonClickListener listener)
```
    Called to add a listener for polygon clicks.
    
    Parameters:
    
    listener - Listener to be added for polygon clicks.
  - removeOnPolygonClickListener
```
void removeOnPolygonClickListener(TomtomMapCallback.OnPolygonClickListener listener)
```
    Called to remove a listener for polygon clicks.
    
    Parameters:
    
    listener - Listener to be removed for polygon clicks.
  - removeOnPolygonClickListeners
```
void removeOnPolygonClickListeners()
```
    Remove all registered polygon click listeners.
  - addOnPolylineClickListener
```
void addOnPolylineClickListener(TomtomMapCallback.OnPolylineClickListener listener)
```
    Called to add a listener for polygon clicks.
    
    Parameters:
    
    listener - Listener to be added for polygon clicks.
  - removeOnPolylineClickListener
```
void removeOnPolylineClickListener(TomtomMapCallback.OnPolylineClickListener listener)
```
    Called to remove a listener for polyline clicks.
    
    Parameters:
    
    listener - Listener to be removed for polyline clicks.
  - removeOnPolylineClickListeners
```
void removeOnPolylineClickListeners()
```
    Remove all registered polyline click listeners.
  - addOnRouteClickListener
```
void addOnRouteClickListener(TomtomMapCallback.OnRouteClickListener listener)
```
    Called to add a listener for route clicks.
    
    Parameters:
    
    listener - Listener to be added for route clicks.
  - removeOnRouteClickListener
```
void removeOnRouteClickListener(TomtomMapCallback.OnRouteClickListener listener)
```
    Called to remove a listener for route clicks.
    
    Parameters:
    
    listener - Listener to be removed for route clicks.
  - removeOnRouteClickListeners
```
void removeOnRouteClickListeners()
```
    Remove all registered route click listeners.
  - setLocationSource
```
void setLocationSource(@NonNull
                       LocationSource locationSource)
```
    Set for map location source. Map take from location source information about location of chevron.
    
    Parameters:
    
    locationSource -
  - getLocationSource
```
@NonNull
LocationSource getLocationSource()
```
    Location source provide information about map location. LocationSource is registered in onResume and unregister in onPause method.
  - getDefaultLocationSource
```
@NonNull
LocationSource getDefaultLocationSource()
```
    Default location source implementation. This method creates a new instance that can be used by user.
  - addLocationUpdateListener
```
void addLocationUpdateListener(@NonNull
                               LocationUpdateListener locationUpdateListener)
```
    Add location update listener. When using this method, you shoud remember to unregister using LocationSourceExtension.removeLocationUpdateListener(LocationUpdateListener).
  - removeLocationUpdateListener
```
void removeLocationUpdateListener(@NonNull
                                  LocationUpdateListener locationUpdateListener)
```
    Remove location update listener.

Interface TomtomMap

Method Summary

Methods inherited from interface androidx.core.app.ActivityCompat.OnRequestPermissionsResultCallback

Method Detail

getUiSettings

getTrafficSettings

getLogoSettings

getMarkerSettings

getOverlaySettings

getRouteSettings

getDrivingSettings

getStyleSettings

asMatchingDataProvider

isMyLocationEnabled

setMyLocationEnabled

getGpsPositionIndicator

setGpsPositionIndicator

setGestureDetector

getGestureDetector

clear

setLanguage

setGeopoliticalView

getGesturesDetectionSettings

updateGesturesDetectionSettings

moveMapBy

latLngForPixel

pixelForLatLng

collectLogsToFile

addRoute

getRoutes

clearRoute

displayRoutesOverview

displayRouteOverview

findRouteByID

updateRouteStyle

bringRouteToFront

setRoutesInactive

setRoutesActive

setRouteActive

setRouteInactive

addMarker

getMarkers

findMarkerByPosition

findMarkerByID

findMarkerByTag

removeMarker

removeMarkers

removeMarkerByID

removeMarkerByTag

zoomToAllMarkers

centerOnMyLocation

centerOnMyLocationWithNorthUp

centerOn

centerOn

centerOn

centerOn

centerOn

centerOnWithDefaultZoom

centerOn

zoomTo

zoomIn

zoomOut

getZoomLevel

getZoomLevelForBounds

getCurrentBounds

setCurrentBounds

setCurrentBounds

setPadding

getUserLocation

getCenterOfMap

getDefaultZoomLevel

isUserLocationInMapBoundingBox

addOnMapClickListener

addOnMapLongClickListener

addOnMapViewPortChangedListener

setOnMapChangedListener

addOnMapChangedListener

getOnMapClickListener

getOnMapLongClickListener

getOnMapViewPortChangedListener