MapboxSpeedInfoOptions

class MapboxSpeedInfoOptions

Specifies options for rendering MapboxSpeedInfoView.

Parameters

showUnit

If set to true MapboxSpeedInfoView will render the unit for posted speed limit for MUTCD convention either in MPH or KM/H based on UnitType.IMPERIAL or UnitType.METRIC. Default value is true.

showLegend

If set to true MapboxSpeedInfoView will render the text "Speed Limit" for MUTCD convention. Default value is false.

speedInfoStyle

applies styles to MapboxSpeedInfoView

showSpeedWhenUnavailable

If set to true MapboxSpeedInfoView will render the posted speed with text "--". Default value is false.

renderWithSpeedSign

MapboxSpeedInfoView will always render in Vienna convention if renderWithSpeedSign is assigned to SpeedLimitSign.VIENNA irrespective of the geography user is currently located in. Similarly, MapboxSpeedInfoView will always render in Mutcd convention if renderWithSpeedSign is assigned to SpeedLimitSign.MUTCD irrespective of the geography user is currently located in. If renderWithSpeedSign is assigned to null, MapboxSpeedInfoView will render according to users current geography. Default value is null.

currentSpeedDirection

MapboxSpeedInfoView will render user's current speed relative to posted speed limit according to the value assigned to currentSpeedDirection. Default value is set to CurrentSpeedDirection.BOTTOM

Types

Link copied to clipboard
class Builder

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Regenerate whenever a change is made

Link copied to clipboard
open override fun hashCode(): Int

Regenerate whenever a change is made

Link copied to clipboard
fun toBuilder(): MapboxSpeedInfoOptions.Builder
Link copied to clipboard
open override fun toString(): String

Regenerate whenever a change is made

Properties

Link copied to clipboard
val currentSpeedDirection: CurrentSpeedDirection
Link copied to clipboard
val renderWithSpeedSign: SpeedLimitSign?
Link copied to clipboard
val showLegend: Boolean
Link copied to clipboard
val showSpeedWhenUnavailable: Boolean
Link copied to clipboard
val showUnit: Boolean
Link copied to clipboard
val speedInfoStyle: SpeedInfoStyle