Skip to Content

UnitSystem

enum UnitSystem : Enum<UnitSystem>

Defines the measurement unit system used for displaying distances to the user.

This enum controls how distance values are formatted in navigation announcements, route summaries, and UI elements. The SDK stores all internal distances in meters and converts to the selected unit system only at the presentation layer.

Values are serialized to/from JSON via Jackson’s JsonProperty annotations, matching the values expected by the Lazarillo API.

See also

DEFAULT_UNIT_SYSTEM
RoutingStatusRepository

Entries

METRICMETRIC
Metric system: distances displayed in meters and kilometers.
IMPERIALIMPERIAL
Imperial system: distances displayed in feet and miles.
STEPSSTEPS
Step-based system: distances displayed as an estimated step count. Useful for indoor navigation and accessibility.

Properties

entries

val entries: EnumEntries<UnitSystem>

Returns a representation of an immutable list of all enum entries, in the order they’re declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): UnitSystem

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<UnitSystem>

Returns an array containing the constants of this enum type, in the order they’re declared.

Last updated on