LengthFormat class

Allows a Length to be formatted.

See UnitOfMeasurementFormat for general notes on the pattern syntax, which you can combine with the LengthUnit pattern specifiers as required:

Unit Specifier
S.I. nanometer nm
micrometer μm
millimeter mm
centimeter cm
decimeter dm
meter m
decameter dam
hectometer hm
kilometer km
megameter Mm
gigameter Gm
Imperial thou thou
inch in
foot ft
yard yd
mile mi 
final length = 42.kilometers();

// '42km'
final result1 = LengthFormat().format(length);

// '42 kilometers'
final result2 = LengthFormat(pattern: '0.## U').format(length);

// '42,000 m'
final result3 = LengthFormat(pattern: '###,##0.## u:m').format(length);

See also:

Inheritance

Constructors

LengthFormat({String pattern = '0.##${UnitOfMeasurementFormat.valueUnitSymbolFormatSpecifier}', Set<LengthUnit> permissibleValueUnits = LengthUnits.commonSi, String? locale})

Properties

hashCode → int
The hash code for this object.
no setterinherited
locale → String?
The locale to use when formatting values.
finalinherited
pattern → String
The pattern that indicates the desired output when formatting input values.
finalinherited
permissibleRateUnits → Set<RateUnit>
finalinherited
permissibleValueUnits → Set<LengthUnit>
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

format(Length input) → String
Formats input according to the pattern and locale of this format.
inherited
getLargestUnit(Length input) → LengthUnit
Determines the largest denomination of unit in input that has a value of at least 1.
override
getPatternSpecifierFor(LengthUnit valueUnit) → String
Gets the pattern specifier for the given value unit.
inherited
getPermissibleRateUnits() → Set<RateUnit>
Gets a set of permissible RateUnit values.
inherited
getPermissibleValueUnits() → Set<LengthUnit>
Gets a set of permissible TUnit values.
inherited
getUnitName(LengthUnit unit, String locale) → String
Gets the a unit name in the given locale.
inherited
getUnitQuantity(Length input, LengthUnit unit) → Rational
Determines how many units of unit the input contains, including any fractional portion.
override
getUnitSymbol(LengthUnit unit, String locale) → String
Gets the a unit symbol in the given locale.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pluralizeValueUnits(String locale) → bool
Determines whether value units should be pluralized. Defaults to true.
inherited
scaleToRateUnit(Length input, RateUnit rateUnit) → Length
Scales input, which is assumed to be a rated unit of measurement, so that its rate is rateUnit.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited