Package com.mapbox.navigation.ui.maps

Types

Link copied to clipboard
class BuildingHighlightConfig

Building Highlight component configuration class.

Link copied to clipboard
class CameraModeConfig

Camera mode button component configuration class.

Link copied to clipboard
class LocationPuckConfig

Location puck component configuration class.

Link copied to clipboard
class NavigationCameraConfig

NavigationCamera component configuration class.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
fun interface PredictiveCacheControllerErrorHandler

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

Link copied to clipboard
class RecenterButtonConfig

Recenter button component configuration class.

Link copied to clipboard
class RoadNameConfig

Road name component configuration class.

Link copied to clipboard
class RouteArrowConfig

Route arrow component configuration class.

Link copied to clipboard
class RouteLineConfig

Route line component configuration class.

Functions

Link copied to clipboard
fun ComponentInstaller.buildingHighlight(mapView: MapView, config: BuildingHighlightConfig.() -> Unit = {}): Installation

Install component that highlights building upon arrival.

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

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

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

Install component that renders LocationPuck.

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

Install NavigationCamera component.

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

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

Link copied to clipboard
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.

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

Install component that renders route line arrows on the map.

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

Install component that renders route line on the map.