Package com.mapbox.navigation.ui.maps

Types

CameraModeConfig

class CameraModeConfig

Camera mode button component configuration class.

LocationPuckConfig

class LocationPuckConfig

Location puck component configuration class.

NavigationCameraConfig

class NavigationCameraConfig

NavigationCamera component configuration class.

NavigationStyles

object NavigationStyles

An object that links to default navigation styles. We recommend using these map styles for an optimized map appearance for navigation use-cases.

PredictiveCacheController

@UiThread

class PredictiveCacheController(predictiveCacheOptions: PredictiveCacheOptions)

Predictive caching is a system that downloads necessary visual map and guidance data resources along the route upfront, before they are needed, in an attempt to provide a smooth experience even when connectivity is lost while using the app.

PredictiveCacheControllerErrorHandler

fun interface PredictiveCacheControllerErrorHandler

Listener that gets notified whenever there's an error with Predictive Cache.

RecenterButtonConfig

class RecenterButtonConfig

Recenter button component configuration class.

RoadNameConfig

class RoadNameConfig

Road name component configuration class.

RouteArrowConfig

class RouteArrowConfig

Route arrow component configuration class.

RouteLineConfig

class RouteLineConfig

Route line component configuration class.

Functions

cameraModeButton

fun ComponentInstaller.cameraModeButton(button: MapboxCameraModeButton, config: CameraModeConfig.() -> Unit = {}): Installation

Install component that toggles NavigationCamera between NavigationCameraState.OVERVIEW and NavigationCameraState.FOLLOWING on button click.

locationPuck

fun ComponentInstaller.locationPuck(mapView: MapView, config: LocationPuckConfig.() -> Unit = {}): Installation

Install component that renders LocationPuck.

navigationCamera

fun ComponentInstaller.navigationCamera(mapView: MapView, config: NavigationCameraConfig.() -> Unit = {}): Installation

Install NavigationCamera component.

recenterButton

fun ComponentInstaller.recenterButton( mapView: MapView, button: MapboxExtendableButton, config: RecenterButtonConfig.() -> Unit = {}): Installation

Install component that re-centers the mapView to device location on button click.

roadName

fun ComponentInstaller.roadName( mapView: MapView, roadNameView: MapboxRoadNameView, config: RoadNameConfig.() -> Unit = {}): Installation

Install component that updates MapboxRoadNameView with a road name that matches current device location.

routeArrow

fun ComponentInstaller.routeArrow(mapView: MapView, config: RouteArrowConfig.() -> Unit = {}): Installation

Install component that renders route line arrows on the map.

routeLine

fun ComponentInstaller.routeLine(mapView: MapView, config: RouteLineConfig.() -> Unit = {}): Installation

Install component that renders route line on the map.