DistanceFormatter
class DistanceFormatter( context: Context, metricFormattingRanges: List<DistanceFormattingRange> = DEFAULT_METRIC_RANGES, imperialFormattingRanges: List<DistanceFormattingRange> = DEFAULT_IMPERIAL_RANGES)
Content copied to clipboard
Formatter to convert a Distance object to a FormattedDistance.
Parameters
context
Context used to retrieve a unit abbreviation string.
metricFormattingRanges
DistanceFormattingRange used for conversion to Units.METRIC or if the current locale is not set to Locale.US or Locale.UK.
imperialFormattingRanges
DistanceFormattingRange used for conversion to Units.IMPERIAL or if the current locale is set to Locale.US or Locale.UK.
Important: This is a Public Preview API. It may be changed or removed at any time.
Constructors
Link copied to clipboard
fun DistanceFormatter( context: Context, metricFormattingRanges: List<DistanceFormattingRange> = DEFAULT_METRIC_RANGES, imperialFormattingRanges: List<DistanceFormattingRange> = DEFAULT_IMPERIAL_RANGES)
Content copied to clipboard
Functions
Link copied to clipboard
fun format(distance: Distance, units: Units = Units.AUTO): FormattedDistance
Content copied to clipboard
Formats provided distance using metricFormattingRanges and imperialFormattingRanges.