Install in Dash
DistanceFormatter Class Reference
DistanceFormatter
open class DistanceFormatter : Formatter, NSSecureCodingA formatter that provides localized representations of distance units and measurements.
This class is limited to UnitLength and its behavior is more specific to distances than MeasurementFormatter. By default, the class automatically localizes and rounds the measurement using Measurement.localized(into:) and Locale.nationalizedCurrent. Measurements can be formatted into either strings or attributed strings.
-
Declaration
Swift
public static var supportsSecureCoding: Bool -
Options for choosing and formatting the unit.
Seealso
MeasurementFormatter.unitOptionsDeclaration
Swift
open var unitOptions: MeasurementFormatter.UnitOptions { get set } -
The unit style.
Seealso
MeasurementFormatter.unitStyleDeclaration
Swift
open var unitStyle: Formatter.UnitStyle { get set } -
The locale that determines the chosen unit, name of the unit, and number formatting.
Seealso
MeasurementFormatter.localeDeclaration
Swift
open var locale: Locale { get set } -
The underlying measurement formatter.
Declaration
Swift
@NSCopying open var measurementFormatter: MeasurementFormatter -
Declaration
Swift
public override init() -
Declaration
Swift
public required init?(coder decoder: NSCoder)
View Source on GitHub
-
Creates and returns a localized, formatted string representation of the given distance in meters.
The distance is converted from meters to the most appropriate unit based on the locale and quantity.
Seealso
MeasurementFormatter.string(from:)Declaration
Swift
open func string(from distance: CLLocationDistance) -> StringParameters
distanceThe distance, measured in meters, to localize and format.
Return Value
A localized, formatted representation of the distance.
-
Creates and returns a localized, formatted attributed string representation of the given distance in meters.
The distance is converted from meters to the most appropriate unit based on the locale and quantity.
NSAttributedString.Key.quantityis applied to the range representing the quantity. For example, the “5” in “5 km” has a quantity attribute set to 5.Declaration
Swift
open func attributedString(from distance: CLLocationDistance, defaultAttributes attributes: [NSAttributedString.Key : Any]? = nil) -> NSAttributedStringParameters
distanceThe distance, measured in meters, to localize and format.
defaultAttributesThe default attributes to apply to the resulting attributed string.
Return Value
A localized, formatted representation of the distance.
-
Creates and returns a localized, formatted string representation of the given measurement.
Seealso
MeasurementFormatter.string(from:)Declaration
Swift
open func string(from measurement: Measurement<UnitLength>) -> StringParameters
measurementThe measurement to localize and format.
Return Value
A localized, formatted representation of the measurement.
-
Creates and returns a localized, formatted attributed string representation of the given measurement.
NSAttributedString.Key.quantityis applied to the range representing the quantity. For example, the “5” in “5 km” has a quantity attribute set to 5.Declaration
Swift
open func attributedString(from measurement: Measurement<UnitLength>, defaultAttributes attributes: [NSAttributedString.Key : Any]? = nil) -> NSAttributedStringParameters
measurementThe measurement to localize and format.
defaultAttributesThe default attributes to apply to the resulting attributed string.
Return Value
A localized, formatted representation of the measurement.
-
Declaration
Swift
open override func string(for obj: Any?) -> String? -
Declaration
Swift
open override func attributedString(for obj: Any, withDefaultAttributes attrs: [NSAttributedString.Key : Any]? = nil) -> NSAttributedString?