Distance
Metres, kilometres, miles. One value
A length, shaped like Duration: build one in any unit and read it back in another. formatted() goes through Format, so it prints the unit the reader's region uses.
Properties
inMetersNumberThe distance in metres.
inKilometersNumberThe distance in kilometres.
inMilesNumberThe distance in miles.
inFeetNumberThe distance in feet.
Methods
.formatted(options?)StringLocalised text for this distance.
- options Any
- to String
Convert to this unit. Left out, the region decides.
- style String
short, medium or long.
- digits Number
Maximum decimal places.
- to String
Distance.meters(value)RootlessDistanceA distance in metres.
- value Number required
Distance.kilometers(value)RootlessDistanceA distance in kilometres.
- value Number required
Distance.miles(value)RootlessDistanceA distance in miles.
- value Number required
Distance.feet(value)RootlessDistanceA distance in feet.
- value Number required
Examples
Showing a distance
var d = Location.current().distanceTo(home);
Text(d.formatted()); // "4.2 km" or "2.6 mi"
Text(String(Math.round(d.inMeters)) + " m");