NavigationMapboxMap

open class NavigationMapboxMap : LifecycleObserver

Wrapper class for MapboxMap.

This class initializes various map-related components and plugins that are useful for providing a navigation-driven map experience.

These APIs include drawing a route line, camera animations, and more.

Constructors

NavigationMapboxMap

open fun NavigationMapboxMap(mapView: MapView, mapboxMap: MapboxMap, lifecycleOwner: LifecycleOwner)

Constructor that can be used once OnMapReadyCallback has been called via getMapAsync.

NavigationMapboxMap

open fun NavigationMapboxMap(mapView: MapView, mapboxMap: MapboxMap, lifecycleOwner: LifecycleOwner, vanishRouteLineEnabled: Boolean)

Constructor that can be used once OnMapReadyCallback has been called via getMapAsync.

NavigationMapboxMap

open fun NavigationMapboxMap(mapView: MapView, mapboxMap: MapboxMap, lifecycleOwner: LifecycleOwner, routeBelowLayerId: String)

Constructor that can be used once OnMapReadyCallback has been called via getMapAsync.

NavigationMapboxMap

open fun NavigationMapboxMap(mapView: MapView, mapboxMap: MapboxMap, lifecycleOwner: LifecycleOwner, routeBelowLayerId: String, vanishRouteLineEnabled: Boolean, useSpecializedLocationLayer: Boolean)

Constructor that can be used once OnMapReadyCallback has been called via getMapAsync.

NavigationMapboxMap

@TestOnly()

open fun NavigationMapboxMap(layerInteractor: MapLayerInteractor)

NavigationMapboxMap

@TestOnly()

open fun NavigationMapboxMap(locationComponent: LocationComponent)

NavigationMapboxMap

@TestOnly()

open fun NavigationMapboxMap(mapRoute: NavigationMapRoute)

NavigationMapboxMap

@TestOnly()

open fun NavigationMapboxMap(navigationSymbolManager: NavigationSymbolManager)

NavigationMapboxMap

@TestOnly()

open fun NavigationMapboxMap(mapWayName: MapWayName, mapFpsDelegate: MapFpsDelegate)

NavigationMapboxMap

@TestOnly()

open fun NavigationMapboxMap(mapWayName: MapWayName, mapFpsDelegate: MapFpsDelegate, mapRoute: NavigationMapRoute, mapCamera: NavigationCamera, locationFpsDelegate: LocationFpsDelegate)

NavigationMapboxMap

@TestOnly()

open fun NavigationMapboxMap(mapWayName: MapWayName, mapFpsDelegate: MapFpsDelegate, mapRoute: NavigationMapRoute, mapCamera: NavigationCamera, locationFpsDelegate: LocationFpsDelegate, locationComponent: LocationComponent, vanishRouteLineEnabled: Boolean)

NavigationMapboxMap

@TestOnly()

open fun NavigationMapboxMap(mapboxMap: MapboxMap, layerInteractor: MapLayerInteractor, adjustor: MapPaddingAdjustor)

Functions

addCustomMarker

open fun addCustomMarker(options: SymbolOptions): Symbol

Adds a custom marker to the map based on the options provided.

addDestinationMarker

open fun addDestinationMarker(position: Point)

Adds a marker icon on the map at the given position.

addOnCameraTrackingChangedListener

open fun addOnCameraTrackingChangedListener(listener: OnCameraTrackingChangedListener)

Add a OnCameraTrackingChangedListener to the LocationComponent that iswrapped within this class.

addOnWayNameChangedListener

open fun addOnWayNameChangedListener(listener: OnWayNameChangedListener): Boolean

Add a OnWayNameChangedListener for listening to updatesto the way name shown on the map below the location icon.

addProgressChangeListener

open fun addProgressChangeListener(navigation: MapboxNavigation)

Can be used to automatically drive the map camera, puck and route updateswhen STARTED.

@Deprecated()

open fun addProgressChangeListener(navigation: MapboxNavigation, enableVanishingRouteLine: Boolean)

Use addProgressChangeListener Can be used to automatically drive the map camera, puck and route updateswhen STARTED.

adjustLocationIconWith

open fun adjustLocationIconWith(customPadding: Array<Int>)

Use this method to position the location icon on the map.

clearMarkers

open fun clearMarkers()

Clears all markers on the map that have been added by this class.

clearMarkersWithIconImageProperty

open fun clearMarkersWithIconImageProperty(markerIconImageProperty: String)

Clears all markers with the specified icon image.

clearMarkerWithId

open fun clearMarkerWithId(markerId: Long)

Clears marker with the specified marker id.

disableVanishingRouteLine

open fun disableVanishingRouteLine()

This will disable the feature to change the appearance of the route line behind thepuck as it moves across the map.

drawIdentifiableRoute

open fun drawIdentifiableRoute(route: IdentifiableRoute)

drawIdentifiableRoutes

open fun drawIdentifiableRoutes(routes: List<IdentifiableRoute>)

drawRoute

open fun drawRoute(route: DirectionsRoute)

Will draw the given DirectionsRoute on the map using the colors definedin your given style.

drawRoutes

open fun drawRoutes(routes: List<out DirectionsRoute>)

Will draw the given list of DirectionsRoute on the map using the colors definedin your given style.

enableVanishingRouteLine

open fun enableVanishingRouteLine()

This will enable the feature to change the appearance of the route line behind thepuck as it moves across the map.

hideRoute

open fun hideRoute()

Will hide the drawn route displayed on the map.

isIncidentsVisible

open fun isIncidentsVisible(): Boolean

Returns true if the map has incidents layers and they are visible andwill return false otherwise.

isTrafficVisible

open fun isTrafficVisible(): Boolean

Returns true if the map has traffic layers and they are visible andwill return false otherwise.

onNewRouteProgress

open fun onNewRouteProgress(routeProgress: RouteProgress)

Can be used to manually update the route progress.

removeOnCameraTrackingChangedListener

open fun removeOnCameraTrackingChangedListener(listener: OnCameraTrackingChangedListener)

Remove a OnCameraTrackingChangedListener from the LocationComponent that iswrapped within this class.

removeOnWayNameChangedListener

open fun removeOnWayNameChangedListener(listener: OnWayNameChangedListener): Boolean

Remove a OnWayNameChangedListener for listening to updatesto the way name shown on the map below the location icon.

removeProgressChangeListener

open fun removeProgressChangeListener()

Removes the previously registered progress change listener.

resetCameraPositionWith

open fun resetCameraPositionWith(trackingCameraMode: Int)

Resets the map camera / padding to the last known camera position.

resetPadding

open fun resetPadding()

This method resets the map padding to the default padding that isgenerated when navigation begins (location icon moved to lower half of the screen) orthe custom padding that was last passed via adjustLocationIconWith.

restoreStateFrom

open fun restoreStateFrom(inState: Bundle)

Can be used to restore a NavigationMapboxMap after it has been initialized.

resumeCamera

open fun resumeCamera(location: Location)

Centers the map camera around the provided Location.

retrieveCamera

open fun retrieveCamera(): NavigationCamera

Provides the camera being used to animate the map camera positionsalong the route, driven by the progress change listener.

retrieveMap

@NonNull()

open fun retrieveMap(): MapboxMap

Provides the MapboxMap originally given in the constructor.

retrieveMapRoute

open fun retrieveMapRoute(): NavigationMapRoute

Provides the object being used to draw the route line.

saveStateWith

open fun saveStateWith(outState: Bundle)

Can be used to store the current state of the map in onSaveInstanceState.

setCamera

open fun setCamera(camera: Camera)

Set Camera which allows you to perform operations like zoom, tilt etc.

setOnRouteSelectionChangeListener

open fun setOnRouteSelectionChangeListener(listener: OnRouteSelectionChangeListener)

Set a OnRouteSelectionChangeListener to know which route the user has currentlyselected as their primary route.

setPuckDrawableSupplier

open fun setPuckDrawableSupplier(supplier: PuckDrawableSupplier)

Allows to pass in a custom implementation of PuckDrawableSupplier

showAlternativeRoutes

open fun showAlternativeRoutes(alternativesVisible: Boolean)

Toggle whether or not you'd like the map to display the alternative routes.

showRoute

open fun showRoute()

Will show the drawn route displayed on the map.

showRouteOverview

open fun showRouteOverview(padding: Array<Int>)

Adjusts the map camera to DirectionsRoute being traveled along.

startCamera

open fun startCamera(directionsRoute: DirectionsRoute)

Centers the map camera to the beginning of the provided DirectionsRoute.

takeScreenshot

open fun takeScreenshot(snapshotReadyCallback: MapboxMap.SnapshotReadyCallback)

Used to take the snapshot of the current state of the map.

updateCameraTrackingMode

open fun updateCameraTrackingMode(trackingMode: Int)

Updates the NavigationCamera.TrackingMode that will be used when camera tracking is enabled.

updateIncidentsVisibility

open fun updateIncidentsVisibility(isVisible: Boolean)

Updates the visibility of incidents layers on the map (if any exist).

updateLocation

open fun updateLocation(location: Location)

Updates the location icon on the map and way name data (if found)for the given Location.

open fun updateLocation(locations: List<Location>)

This method can be used to provide the list of locations where the last one is the targetand the rest are intermediate points used as the animation path.The puck and the camera will be animated between each of the points linearly until reaching the target.

updateLocationFpsThrottleEnabled

open fun updateLocationFpsThrottleEnabled(isEnabled: Boolean)

Enabled by default, the navigation map will throttle frames per second of the location iconbased on the map zoom level.

updateLocationLayerRenderMode

open fun updateLocationLayerRenderMode(renderMode: Int)

Updates how the user location is shown on the map.

updateLocationVisibilityTo

open fun updateLocationVisibilityTo(isVisible: Boolean)

Hide or show the location icon on the map.

updateMapFpsThrottle

open fun updateMapFpsThrottle(maxFpsThreshold: Int)

The maximum preferred frames per second at which to render the map.

updateMapFpsThrottleEnabled

open fun updateMapFpsThrottleEnabled(isEnabled: Boolean)

Enabled by default, the navigation map will throttle frames per second when the application haslimited resources, such as when the device is running on battery power.

updateTrafficVisibility

open fun updateTrafficVisibility(isVisible: Boolean)

Updates the visibility of traffic layers on the map (if any exist).

updateWaynameQueryMap

open fun updateWaynameQueryMap(isEnabled: Boolean)

Enables or disables the way name chip underneath the location icon.

Properties

STREETS_LAYER_ID

val STREETS_LAYER_ID: String