dojo/currency.__FormatOptions (version 1.10)

Note: This is not a real constructor, but just a description of the type of object that should be passed as a parameter to some method(s), and/or the return value from some method(s). In other words, the type exists only for documentation purposes, and you cannot call new currency.__FormatOptions()

Property Summary

  • currencyan ISO4217 currency code, a three letter sequence like "USD".
  • fractionalIf false, show no decimal places, overriding places and pattern settings.
  • localeoverride the locale used to determine formatting rules
  • patternoverride formatting pattern with this string.
  • placesnumber of decimal places to show.
  • round5 rounds to nearest .5; 0 rounds to nearest whole (default). -1 means do not round.
  • symbollocalized currency symbol.
  • typeShould not be set.

Properties

currency
Defined by: dojo/currency

an ISO4217 currency code, a three letter sequence like "USD". For use with dojo.currency only.

fractional
Defined by: dojo/number

If false, show no decimal places, overriding places and pattern settings.

locale
Defined by: dojo/number

override the locale used to determine formatting rules

pattern
Defined by: dojo/number

override formatting pattern with this string. Default value is based on locale. Overriding this property will defeat localization. Literal characters in patterns are not supported.

places
Defined by: dojo/currency

number of decimal places to show. Default is defined based on which currency is used.

round
Defined by: dojo/number

5 rounds to nearest .5; 0 rounds to nearest whole (default). -1 means do not round.

symbol
Defined by: dojo/currency

localized currency symbol. The default will be looked up in table of supported currencies in dojo.cldr A ISO4217 currency code will be used if not found.

type
Defined by: dojo/currency

Should not be set. Value is assumed to be "currency".

Error in the documentation? Can’t find what you are looking for? Let us know!