/tripkit/TripKitAndroidUI/com.skedgo.tripkit.ui.utils/DistanceFormatter/format

format

\

@JvmOverloads

fun format(distanceInMeters: Int): String

Format a distance for display

Return

distance string formatted according to the rules of hte formatter.

Parameters

androidJvm

distanceInMeters the actual distance in meters.

\ fun format(distanceInMeters: Int, units: DistanceFormatter.DistanceUnits): String

Format distance for display using specified distance units.

Return

distance string formatted according to the rules of the formatter.

Parameters

androidJvm

distanceInMeters the actual distance in meters.
units miles or kilometers.

\ fun format(distanceInMeters: Int, locale: Locale): String

Format distance for display using specified locale.

Return

distance string formatted according to the rules of the formatter.

Parameters

androidJvm

distanceInMeters the actual distance in meters.
locale Locale that defines the number format for displaying distance.

\ fun format(distanceInMeters: Int, locale: Locale, units: DistanceFormatter.DistanceUnits): String

Format distance for display using specified locale and units.

Return

distance string formatted according to the rules of the formatter.

Parameters

androidJvm

distanceInMeters the actual distance in meters.
locale Locale that defines the number format for displaying distance.
units miles or kilometers.