Constructor
new module:caplin/element/formatter/LocalisedAmountFormatter()
Formats a number into a localised string representation.
1234567.89 = 1,234,567.89 in english locale
1234567.89 = 1.234.567,89 in french locale
It is typically used in the XML Renderer Framework, but can be invoked programmatically:
LocalisedAmountFormatter Formats a number to a configurable number of decimal places
according to current locale of browser. It automatically detects the current locale of the the
browser and uses that to format numbers. For example1234567.89 = 1,234,567.89 in english locale
1234567.89 = 1.234.567,89 in french locale
It is typically used in the XML Renderer Framework, but can be invoked programmatically:
caplin.element.formatter.LocalisedAmountFormatter.format(1234567890, {})
caplin.element.formatter.LocalisedAmountFormatter.format(1234567890, {dp: 4})
- Implements:
Methods
-
format(vValue, mAttributes) → {String}
-
Formats a number into an localised string representation.
Parameters:
Name Type Description vValueNumber the numeric amount (if a string is passed it is returned unchanged). mAttributesMap a list of attributes. Properties
Name Type Description dpNumber number of decimal places to be displayed. Rounding occurs according to standard javascript behaviour. Returns:
the tokenized amount.- Type
- String