UI Drop-In/com.mapbox.navigation.dropin/ViewOptionsCustomization

ViewOptionsCustomization

A class that allows you to define values for various different properties used by the NavigationView. If not specified, NavigationView uses the default values defined for each of these properties.

Constructors

fun ViewOptionsCustomization()

Types

Companion

object Companion

Properties

buildingHighlightOptions

var buildingHighlightOptions: MapboxBuildingHighlightOptions? = null

Provide custom MapboxBuildingHighlightOptions for the MapboxBuildingView. Use defaultBuildingHighlightOptions to reset to default.

distanceFormatterOptions

var distanceFormatterOptions: DistanceFormatterOptions? = null

Set to override DistanceFormatterOptions

enableBuildingHighlightOnArrival

var enableBuildingHighlightOnArrival: Boolean? = null

Set whether to highlight a building upon arrival. Set to true for the default behavior.

enableMapLongClickIntercept

var enableMapLongClickIntercept: Boolean? = null

Set to false if you don't want NavigationView to intercept OnMapLongClickListener events. Set to true as the default behavior.

infoPanelForcedState

var infoPanelForcedState: Int? = null

Set to override Info Panel BottomSheet state. Setting this value to one of BottomSheetBehavior.STATE_COLLAPSED, BottomSheetBehavior.STATE_EXPANDED, BottomSheetBehavior.STATE_HIDDEN or BottomSheetBehavior.STATE_HALF_EXPANDED will disable default (auto-hiding) behaviour. Set to 0 to restore the default behavior.

isInfoPanelHideable

var isInfoPanelHideable: Boolean? = null

Sets whether the Info Panel can hide when it is swiped down. Set to false for the default behavior.

mapStyleUriDay

var mapStyleUriDay: String? = null

Provide custom navigation style for day mode. Use NavigationStyles.NAVIGATION_DAY_STYLE to reset to default.

mapStyleUriNight

var mapStyleUriNight: String? = null

Provide custom navigation style for night mode. Use NavigationStyles.NAVIGATION_NIGHT_STYLE to reset to default.

routeArrowOptions

var routeArrowOptions: RouteArrowOptions? = null

Provide custom route arrow options. Use ViewOptionsCustomization.defaultRouteArrowOptions to reset to default.

routeLineOptions

var routeLineOptions: MapboxRouteLineOptions? = null

Provide custom route line options. Use ViewOptionsCustomization.defaultRouteLineOptions to reset to default.

showActionButtons

var showActionButtons: Boolean? = null

Sets whether action buttons should be visible. Set to true for the default behavior.

showArrivalText

var showArrivalText: Boolean? = null

Sets whether the arrival text view should be visible. Set to true for the default behavior.

showCameraDebugInfo

var showCameraDebugInfo: Boolean? = null

Set to show the camera debug info window. Set to false for the default behavior.

showCameraModeActionButton

var showCameraModeActionButton: Boolean? = null

Sets whether the camera mode button should be visible. Set to true for the default behavior.

showCompassActionButton

var showCompassActionButton: Boolean? = null

Sets whether the compass action button should be visible. Set to false for the default behavior.

showEndNavigationButton

var showEndNavigationButton: Boolean? = null

Sets whether the end navigation button should be visible. Set to true for the default behavior.

showInfoPanelInFreeDrive

var showInfoPanelInFreeDrive: Boolean? = null

Set if the Info Panel should be visible for the Free Drive state. When set to trueInfoPanelBinder will only render an empty info panel. You are responsible to inflate appropriate Binder to render the content you would like to show on the info panel during free drive. Set to false for the default behavior.

showManeuver

var showManeuver: Boolean? = null

Sets whether the maneuver view should be visible. Set to true for the default behavior.

showMapScalebar

var showMapScalebar: Boolean? = null

Sets whether the map scalebar should be visible. Set to false for the default behavior.

showPoiName

var showPoiName: Boolean? = null

Sets whether the POI text view should be visible. Set to true for the default behavior.

showRecenterActionButton

var showRecenterActionButton: Boolean? = null

Sets whether the recenter camera button should be visible. Set to true for the default behavior.

showRoadName

var showRoadName: Boolean? = null

Sets whether the road name view should be visible. Set to true for the default behavior.

showRoutePreviewButton

var showRoutePreviewButton: Boolean? = null

Sets whether the route preview button should be visible. Set to true for the default behavior.

showSpeedLimit

var showSpeedLimit: Boolean? = null

Sets whether the speed limit view should be visible. Set to true for the default behavior.

showStartNavigationButton

var showStartNavigationButton: Boolean? = null

Sets whether the start navigation button should be visible. Set to true for the default behavior.

showToggleAudioActionButton

var showToggleAudioActionButton: Boolean? = null

Sets whether the toggle audio button should be visible. Set to true for the default behavior.

showTripProgress

var showTripProgress: Boolean? = null

Sets whether the trip progress view should be visible. Set to true for the default behavior.