Builder

class Builder

Responsible for instantiating an instance of MapboxRouteLineOptions

Parameters

context

an instance of Context

routeLineResources

an instance of RouteLineResources

routeLineBelowLayerId

determines the elevation of the route layers

routeStyleDescriptors

a collection of RouteStyleDescriptor objects

vanishingRouteLineEnabled

indicates if the vanishing route line feature is enabled

displayRestrictedRoadSections

indicates if the route line will display restricted road sections with a dashed line

styleInactiveRouteLegsIndependently

enabling this feature will change the color of the route legs that aren't currently being navigated. See RouteLineColorResources to specify the color used.

displaySoftGradientForTraffic

enabling this will display the traffic color transitions with a gradual gradient color blend. If false the color transitions will abruptly transition from one color to the next.

softGradientTransition

this value influences the length of the color transition when the displaySoftGradientForTraffic param is set to true

vanishingRouteLineUpdateIntervalNano

can be used to decrease the frequency of the vanishing route line updates improving the performance at the expense of visual appearance of the vanishing point on the line during navigation.

iconPitchAlignment

the pitch alignment value used for waypoint icons. The default is IconPitchAlignment.MAP

Constructors

Builder

androidJvm

fun Builder(context: Context)

Responsible for instantiating an instance of MapboxRouteLineOptions

Functions

build

androidJvm

fun build(): MapboxRouteLineOptions

displayRestrictedRoadSections

androidJvm

fun displayRestrictedRoadSections(displayRestrictedRoadSections: Boolean): MapboxRouteLineOptions.Builder

Indicates if the route line will display restricted road sections with a dashed line.

displaySoftGradientForTraffic

androidJvm

fun displaySoftGradientForTraffic(enable: Boolean): MapboxRouteLineOptions.Builder

Influences the appearance of the gradient used for the traffic line.

equals

androidJvm

open operator fun equals(other: Any?): Boolean

hashCode

androidJvm

open fun hashCode(): Int

iconPitchAlignment

androidJvm

fun iconPitchAlignment(iconPitchAlignment: IconPitchAlignment): MapboxRouteLineOptions.Builder

Orientation of waypoint icons when map is pitched.

softGradientTransition

androidJvm

fun softGradientTransition(transitionDistance: Int): MapboxRouteLineOptions.Builder

When displayRestrictedRoadSections is set to true this value will influence the length of the gradient transition between traffic congestion colors.

styleInactiveRouteLegsIndependently

androidJvm

fun styleInactiveRouteLegsIndependently(enable: Boolean): MapboxRouteLineOptions.Builder

Enabling this feature will result in route legs that aren't currently being navigated to be color differently than the active leg.

toString

androidJvm

open fun toString(): String

vanishingRouteLineUpdateInterval

androidJvm

fun vanishingRouteLineUpdateInterval(interval: Long = RouteLayerConstants.DEFAULT_VANISHING_POINT_MIN_UPDATE_INTERVAL_NANO): MapboxRouteLineOptions.Builder

Used for throttling the interval of updates to the vanishing route line.

waypointLayerIconAnchor

androidJvm

fun waypointLayerIconAnchor(iconAnchor: IconAnchor = IconAnchor.CENTER): MapboxRouteLineOptions.Builder

Determines the icon anchor for the SymbolLayer that hosts the waypoint icons including the icons for the origin and destination points.

waypointLayerIconOffset

androidJvm

fun waypointLayerIconOffset(iconOffset: List<Double> = listOf(0.0, 0.0)): MapboxRouteLineOptions.Builder

Determines the icon offset for the SymbolLayer that hosts the waypoint icons including the icons for the origin and destination points.

withRouteLineBelowLayerId

androidJvm

fun withRouteLineBelowLayerId(layerId: String): MapboxRouteLineOptions.Builder

Indicates the elevation of the route line related layers.

withRouteLineResources

androidJvm

fun withRouteLineResources(resourceProvider: RouteLineResources): MapboxRouteLineOptions.Builder

An instance of RouteLineResources

withRouteStyleDescriptors

androidJvm

fun withRouteStyleDescriptors(routeStyleDescriptors: List<RouteStyleDescriptor>): MapboxRouteLineOptions.Builder

RouteStyleDescriptor is an override of an alternative route line coloring based on a provided identifier.

withTolerance

androidJvm

fun withTolerance(tolerance: Double): MapboxRouteLineOptions.Builder

Douglas-Peucker simplification tolerance (higher means simpler geometries and faster performance) for the GeoJsonSources created to display the route line.

withVanishingRouteLineEnabled

androidJvm

fun withVanishingRouteLineEnabled(isEnabled: Boolean): MapboxRouteLineOptions.Builder

Determines if the vanishing route line feature is enabled.