Builder

class Builder

Used for instantiating the RouteArrowOptions class.

Constructors

Link copied to clipboard
fun Builder(context: Context)

Used for instantiating the RouteArrowOptions class.

Functions

Link copied to clipboard
fun build(): RouteArrowOptions

Applies the supplied parameters and instantiates a RouteArrowOptions

Link copied to clipboard
fun withAboveLayerId(layerId: String): RouteArrowOptions.Builder

Indicates the maneuver arrow map layers appear above this layer on the map. A good starting point for this is TOP_LEVEL_ROUTE_LINE_LAYER_ID.

Link copied to clipboard
fun withArrowCasingColor(@ColorInt color: Int): RouteArrowOptions.Builder

Indicates the color of the arrow shaft border.

Link copied to clipboard
fun withArrowColor(@ColorInt color: Int): RouteArrowOptions.Builder

Indicates the color of the arrow shaft.

Link copied to clipboard
fun withArrowheadCasingScalingExpression(expression: Expression): RouteArrowOptions.Builder

An expression that will define the scaling behavior of the maneuver arrow head casing.

Link copied to clipboard
fun withArrowHeadIconCasingDrawable(@DrawableRes drawable: Int): RouteArrowOptions.Builder

Indicates the drawable of the arrow head border.

Link copied to clipboard
fun withArrowHeadIconDrawable(@DrawableRes drawable: Int): RouteArrowOptions.Builder

Indicates the drawable of the arrow head.

Link copied to clipboard
fun withArrowheadScalingExpression(expression: Expression): RouteArrowOptions.Builder

An expression that will define the scaling behavior of the maneuver arrow head.

Link copied to clipboard
fun withArrowShaftCasingScalingExpression(expression: Expression): RouteArrowOptions.Builder

An expression that will define the scaling behavior of the maneuver arrow shaft casing.

Link copied to clipboard
fun withArrowShaftScalingExpression(expression: Expression): RouteArrowOptions.Builder

An expression that will define the scaling behavior of the maneuver arrow shafts.

Link copied to clipboard
fun withFadeOnHighZoomsConfig(config: FadingConfig?): RouteArrowOptions.Builder

Configuration of route arrows fading out (see FadingConfig for details). NOTE: route arrows disappear at zoom levels 14.0 or lower. Make sure zoom levels specified in FadingConfig are greater than 14.0. NOTE: this property guards fading out the arrows on transition from a lower to a higher zoom level, meaning that FadingConfig.startFadingZoom must be less than or equal to FadingConfig.finishFadingZoom.

Link copied to clipboard
fun withSlotName(name: String): RouteArrowOptions.Builder

The slot name to use for route arrow position in the layer stack.

Link copied to clipboard
fun withTolerance(tolerance: Double): RouteArrowOptions.Builder

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