Added in API level 30

UnitWidth

class UnitWidth
kotlin.Any
   ↳ kotlin.Enum<android.icu.number.NumberFormatter.UnitWidth>
   ↳ android.icu.number.NumberFormatter.UnitWidth

An enum declaring how to render units, including currencies. Example outputs when formatting 123 USD and 123 meters in en-CA:

  • NARROW: "$123.00" and "123 m"
  • SHORT: "US$ 123.00" and "123 m"
  • FULL_NAME: "123.00 US dollars" and "123 meters"
  • ISO_CODE: "USD 123.00" and undefined behavior
  • HIDDEN: "123.00" and "123"

This enum is similar to android.icu.text.MeasureFormat.FormatWidth.

Summary

Enum values

Use the formal variant of the currency symbol; for example, "NT$" for the New Taiwan dollar in zh-TW.

Print the full name of the unit, without any abbreviations.

Format the number according to the specified unit, but do not display the unit.

Use the three-digit ISO XXX code in place of the symbol for displaying currencies.

Print an abbreviated version of the unit name.

Print an abbreviated version of the unit name.

Use the alternate variant of the currency symbol; for example, "TL" for the Turkish lira (TRY).

Enum values

FORMAL

Added in API level 33
enum val FORMAL : NumberFormatter.UnitWidth

Use the formal variant of the currency symbol; for example, "NT$" for the New Taiwan dollar in zh-TW.

Behavior of this option with non-currency units is not defined at this time.

FULL_NAME

Added in API level 30
enum val FULL_NAME : NumberFormatter.UnitWidth

Print the full name of the unit, without any abbreviations.

In CLDR, this option corresponds to the default format for measure units and the "¤¤¤" placeholder for currencies.

HIDDEN

Added in API level 30
enum val HIDDEN : NumberFormatter.UnitWidth

Format the number according to the specified unit, but do not display the unit. For currencies, apply monetary symbols and formats as with SHORT, but omit the currency symbol. For measure units, the behavior is equivalent to not specifying the unit at all.

ISO_CODE

Added in API level 30
enum val ISO_CODE : NumberFormatter.UnitWidth

Use the three-digit ISO XXX code in place of the symbol for displaying currencies.

Behavior of this option with non-currency units is not defined at this time.

In CLDR, this option corresponds to the "¤¤" placeholder for currencies.

NARROW

Added in API level 30
enum val NARROW : NumberFormatter.UnitWidth

Print an abbreviated version of the unit name. Similar to SHORT, but always use the shortest available abbreviation or symbol. This option can be used when the context hints at the identity of the unit. For more information on the difference between NARROW and SHORT, see SHORT.

In CLDR, this option corresponds to the "Narrow" format for measure units and the "¤¤¤¤¤" placeholder for currencies.

SHORT

Added in API level 30
enum val SHORT : NumberFormatter.UnitWidth

Print an abbreviated version of the unit name. Similar to NARROW, but use a slightly wider abbreviation or symbol when there may be ambiguity. This is the default behavior.

For example, in es-US, the SHORT form for Fahrenheit is "{0} °F", but the NARROW form is "{0}°", since Fahrenheit is the customary unit for temperature in that locale.

In CLDR, this option corresponds to the "Short" format for measure units and the "¤" placeholder for currencies.

VARIANT

Added in API level 33
enum val VARIANT : NumberFormatter.UnitWidth

Use the alternate variant of the currency symbol; for example, "TL" for the Turkish lira (TRY).

Behavior of this option with non-currency units is not defined at this time.