Caplin Trader 5.1.0

Class: module:ct-element/parser/ThousandsParser

module:ct-element/parser/ThousandsParser()

new module:ct-element/parser/ThousandsParser()

Parses an amount and strips any thousands separators.

ThousandsParser is typically used in the XML Renderer Framework, but can be invoked programmatically as in the following example which evaluates to '8987551787.0':

ThousandsParser.parse('8,987,551,787.0', {})

The number grouping separator will change per locale. The english separator defaults to ',' as in the example above, see the i18n property ct.i18n.number.grouping.separator in other locales for their separators.

See module:ct-element/formatter/ThousandsFormatter for the complementary formatter.
Implements:

Methods

parse(vValue, mAttributes) → {String}

Parses an amount, strips any thousands separators and changes the local radix (decimal point) char into a '.'.

Parameters:
Name Type Description
vValue Variant

the amount.
mAttributes Map

the map of attributes.

Properties
Name Type Attributes Description
separator String <optional>

the token representing thousands (defaults to a comma in en_GB locale).
Returns:

the amount, with any number grouping separators removed

Type
String