TemperatureFormat class
Allows a Length to be formatted.
See UnitOfMeasurementFormat for general notes on the pattern syntax, which you can combine with the TemperatureUnit pattern specifiers as required:
Unit | Specifier | |
---|---|---|
S.I. | nanokelvin | nK |
microkelvin | μK |
|
millikelvin | mK |
|
centikelvin | cK |
|
decikelvin | dK |
|
kelvin | K |
|
Celsius | Degrees Celsius | °C |
Fahrenheit | Degrees Fahrenheit | °F |
final temperature = 42.celsius();
// '42°C'
final result1 = TemperatureFormat().format(temperature);
// '42 Celsius'
final result2 = TemperatureFormat(pattern: '0.## U').format(temperature);
// '107.6 °F'
final result3 = TemperatureFormat(
pattern: '##0.## u:°F',
permissibleValueUnits: TemperatureUnits.all,
).format(temperature);
See also:
- Inheritance
-
- Object
- UnitOfMeasurementFormat<
Temperature, TemperatureUnit> - TemperatureFormat
Constructors
-
TemperatureFormat({String pattern = '0.##${UnitOfMeasurementFormat.valueUnitSymbolFormatSpecifier}', Set<
TemperatureUnit> permissibleValueUnits = TemperatureUnits.celsius, 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<
TemperatureUnit> -
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
format(
Temperature input) → String -
Formats
input
according to the pattern and locale of this format.inherited -
getLargestUnit(
Temperature input) → TemperatureUnit -
Determines the largest denomination of unit in
input
that has a value of at least1
.override -
getPatternSpecifierFor(
TemperatureUnit 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< TemperatureUnit> -
Gets a set of permissible
TUnit
values.inherited -
getUnitName(
TemperatureUnit unit, String locale) → String -
Gets the a
unit
name in the givenlocale
.inherited -
getUnitQuantity(
Temperature input, TemperatureUnit unit) → Rational -
Determines how many units of
unit
theinput
contains, including any fractional portion.override -
getUnitSymbol(
TemperatureUnit 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(
Temperature input, RateUnit rateUnit) → Temperature -
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