Caplin Trader 5.1.0

Class: module:br-formatting/TruncateDecimalFormatter

module:br-formatting/TruncateDecimalFormatter()

Truncates the value to the specified number of decimal places.

TruncateDecimalFormatter is typically used with Presenter, but can be invoked programmatically as in the following example which evaluates to "3.142":

TruncateDecimalFormatter.format(3.14159, {dp:3})

Constructor

new module:br-formatting/TruncateDecimalFormatter()

Implements:

Methods

format(vValue, mAttributes)

Truncates the value to the specified number of decimal places. If the value has already fewer decimal places than the supplied attribute, then the value is not changed.

Attribute Options:

Option Description
dp the number of decimal places at which to truncate.
Parameters:
Name Type Description
vValue Variant

the number (String or Number type).
mAttributes Map

the map of attributes.
Implements:
Returns:

the number formatted to the specified precision.