AreaRateFormat class

Allows an AreaRate to be formatted.

See UnitOfMeasurementFormat for general notes on the pattern syntax and AreaFormat for area-specific notes.

final areaRate = 42.hectares().per(const Duration(seconds: 1));

// '42ha/s'
final result1 = AreaRateFormat().format(areaRate);

// '42 hectares per second'
final result2 = AreaRateFormat(pattern: "0.## U 'per' R").format(areaRate);

// '1,512,000,000 m²/hr'
final result3 = AreaRateFormat(pattern: "###,##0.## u:m²'/'r:hr").format(areaRate);

See also:

• UnitOfMeasurementFormat
• AreaFormat

Inheritance

• Object
• UnitOfMeasurementFormat<AreaRate, AreaUnit>
• AreaRateFormat

Constructors

AreaRateFormat({String pattern = "0.##${UnitOfMeasurementFormat.valueUnitSymbolFormatSpecifier}'/'${UnitOfMeasurementFormat.rateUnitSymbolFormatSpecifier}", Set<AreaUnit> permissibleValueUnits = AreaUnits.commonSi, Set<RateUnit> permissibleRateUnits = RateUnits.hourOrLess, String? locale})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

locale → String?

The locale to use when formatting values.

final, inherited

pattern → String

The pattern that indicates the desired output when formatting input values.

final, inherited

permissibleRateUnits → Set<RateUnit>

final, inherited

permissibleValueUnits → Set<AreaUnit>

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

format(AreaRate input) → String

Formats input according to the pattern and locale of this format.

inherited

getLargestUnit(AreaRate input) → AreaUnit

Determines the largest denomination of unit in input that has a value of at least 1.

override

getPatternSpecifierFor(AreaUnit 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<AreaUnit>

Gets a set of permissible TUnit values.

inherited

getUnitName(AreaUnit unit, String locale) → String

Gets the a unit name in the given locale.

inherited

getUnitQuantity(AreaRate input, AreaUnit unit) → Rational

Determines how many units of unit the input contains, including any fractional portion.

override

getUnitSymbol(AreaUnit 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(AreaRate input, RateUnit rateUnit) → AreaRate

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