QuantityRateFormat class
Allows a QuantityRate to be formatted.
See UnitOfMeasurementFormat for general notes on the pattern syntax and QuantityFormat for quantity-specific notes.
final quantityRate = 42.thousand().per(const Duration(minutes: 1));
// '42K/min'
final result1 = QuantityRateFormat().format(quantityRate);
// '42 thousand per minute'
final result2 = QuantityRateFormat(pattern: "0.## U 'per' R").format(quantityRate);
// '42,000/s'
final result3 = QuantityRateFormat(
pattern: "###,##0.##u:U'/'r:s",
permissibleValueUnits: QuantityUnits.all,
).format(quantityRate);
See also:
- Inheritance
-
- Object
- UnitOfMeasurementFormat<
QuantityRate, QuantityUnit> - QuantityRateFormat
Constructors
-
QuantityRateFormat({String pattern = "0.##${UnitOfMeasurementFormat.valueUnitSymbolFormatSpecifier}'/'${UnitOfMeasurementFormat.rateUnitSymbolFormatSpecifier}", Set<
QuantityUnit> permissibleValueUnits = QuantityUnits.all, Set<RateUnit> permissibleRateUnits = RateUnits.hourOrLess, 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<
QuantityUnit> -
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
format(
QuantityRate input) → String -
Formats
input
according to the pattern and locale of this format.inherited -
getLargestUnit(
QuantityRate input) → QuantityUnit -
Determines the largest denomination of unit in
input
that has a value of at least1
.override -
getPatternSpecifierFor(
QuantityUnit 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< QuantityUnit> -
Gets a set of permissible
TUnit
values.inherited -
getUnitName(
QuantityUnit unit, String locale) → String -
Gets the a
unit
name in the givenlocale
.inherited -
getUnitQuantity(
QuantityRate input, QuantityUnit unit) → Rational -
Determines how many units of
unit
theinput
contains, including any fractional portion.override -
getUnitSymbol(
QuantityUnit unit, String locale) → String -
Gets the a
unit
symbol in the givenlocale
.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(
QuantityRate input, RateUnit rateUnit) → QuantityRate -
Scales
input
, which is assumed to be a rated unit of measurement, so that its rate israteUnit
.override -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited