RouteStyle

data class RouteStyle(    val activeLineColor: Color = DEFAULT_ACTIVE_ROUTE_LINE_COLOR,     val alternativeLineColor: Color = DEFAULT_ALTERNATIVE_ROUTES_LINE_COLOR,     val alternativeLineColorOverrule: Map<Int, Color> = emptyMap(),     val activeLineWidths: List<WidthByZoom> = DEFAULT_LINE_WIDTHS_BY_ZOOM_LEVELS,     val alternativeLineWidths: List<WidthByZoom> = activeLineWidths,     val activeOutlineWidths: List<WidthByZoom> = DEFAULT_OUTLINE_WIDTHS_BY_ZOOM_LEVELS,     val alternativeOutlineWidths: List<WidthByZoom> = activeOutlineWidths)

Represents a style configuration for the routes.

The properties related to the active route (i.e. the properties prefixed with "active") also apply to the selected route during the route planning phase.

During instance construction, certain input values are checked against the range of values expected for that field (e.g., width values must be non-negative).

Important: This is a Public Preview API. It may be changed or removed at any time.

Parameters

activeLineColor

The Color of the active route. You can control the opacity of the route line by using the alpha component of the Color.

alternativeLineColor

The Color of the alternative routes. This color may be overruled individually for each alternative route using alternativeLineColorOverrule. You can control the opacity of the route line by using the alpha component of the Color.

alternativeLineColorOverrule

The colors to individually overrule the color specified in alternativeLineColor. You can control the opacity of the route line by using the alpha component of the Color.

activeLineWidths

The line width (in dp units) of the active route. This parameter must be a non-empty list containing non-negative values for both the width and the zoom level that width is used at. Items in this list must not contain duplicated zoom level values.

alternativeLineWidths

The outline width (in dp units) of the alternative routes. This parameter must be a non-empty list containing non-negative values for both the width and the zoom level that width is used at. Items in this list must not contain duplicated zoom level values.

WARNING: THE CURRENT IMPLEMENTATION REQUIRES THIS LIST TO BE EQUAL TO activeLineWidths.

activeOutlineWidths

The outline width (in dp units) of the active route. This parameter must be a non-empty list containing non-negative values for both the width and the zoom level that width is used at. Items in this list must not contain duplicated zoom level values.

WARNING: THE CURRENT IMPLEMENTATION REQUIRES THE SIZE OF THIS LIST TO BE 1.

alternativeOutlineWidths

The outline width (in dp units) of the alternative routes. This parameter must be a non-empty list containing non-negative values for both the width and the zoom level that width is used at. Items in this list must not contain duplicated zoom level values.

WARNING: THE CURRENT IMPLEMENTATION REQUIRES THIS LIST TO BE EQUAL TO activeOutlineWidths.

Constructors

Link copied to clipboard
fun RouteStyle(    activeLineColor: Color = DEFAULT_ACTIVE_ROUTE_LINE_COLOR,     alternativeLineColor: Color = DEFAULT_ALTERNATIVE_ROUTES_LINE_COLOR,     alternativeLineColorOverrule: Map<Int, Color> = emptyMap(),     activeLineWidths: List<WidthByZoom> = DEFAULT_LINE_WIDTHS_BY_ZOOM_LEVELS,     alternativeLineWidths: List<WidthByZoom> = activeLineWidths,     activeOutlineWidths: List<WidthByZoom> = DEFAULT_OUTLINE_WIDTHS_BY_ZOOM_LEVELS,     alternativeOutlineWidths: List<WidthByZoom> = activeOutlineWidths)

Properties

Link copied to clipboard
val activeLineColor: Color
Link copied to clipboard
val activeLineWidths: List<WidthByZoom>
Link copied to clipboard
val activeOutlineWidths: List<WidthByZoom>
Link copied to clipboard
val alternativeLineColor: Color
Link copied to clipboard
val alternativeLineColorOverrule: Map<Int, Color>
Link copied to clipboard
val alternativeLineWidths: List<WidthByZoom>
Link copied to clipboard
val alternativeOutlineWidths: List<WidthByZoom>