Caplin Trader 5.0.0

Class: module:br-formatting/LocalisedAmountFormatter

module:br-formatting/LocalisedAmountFormatter()

Formats a number into a localised string representation.

LocalisedAmountFormatter Formats a number to a configuarble number of decimal placess according to current locale of browser. It automatically detects the current locale of the the browser and uses that to format numbers. For example
1234567.89 = 1,234,567.89 in english locale
1234567.89 = 1.234.567,89 in french locale
It is typically used with Presenter, but can be invoked programmatically:

LocalisedAmountFormatter.format(1234567890, {}) LocalisedAmountFormatter.format(1234567890, {dp: 4})

Constructor

new module:br-formatting/LocalisedAmountFormatter()

Implements:

Methods

format(vValue, mAttributes)

Formats a number into an localised string representation.

Parameters:
Name Type Description
vValue Variant

the numeric amount (Number type). if a string is passed it is returned unchanged.
mAttributes Map

a list of attributes, as specified here and in. dp: number of decinal places to be displayed. Rounding occurs according to standard javascript behaviour.
Implements:
Returns:

the tokenized amount.