Show:

ia.Formatter Class

Defined in: ia\utils\Formatter.js:1
Module: ia

Provides functions for formatting numbers and strings.

Constructor

ia.Formatter

()

Defined in ia\utils\Formatter.js:1

Methods

format

(
  • value
  • precision
)
String | Number

Defined in ia\utils\Formatter.js:60

Formats a given string or number.

Parameters:

  • value String | Number

    The value.

  • precision Number

    Number of decimals. Uses the default precision if no argument is passed in.

Returns:

String | Number: The formatted value.

formatNumber

(
  • value
  • precision
)
Number

Defined in ia\utils\Formatter.js:88

Get a suitably formatted number.

Parameters:

  • value Number

    A number.

  • precision Number

    Number of decimals. Uses the default precision if no argument is passed in.

Returns:

Number: A number formatted for the current locale, for example 1.2 would be formatted as 1.2 in English, but 1,2 in Español. If the argument passed in is NOT a number, it is returned unchanged.

formatText

(
  • txt
)
String

Defined in ia\utils\Formatter.js:124

Get a suitably formatted string.

Parameters:

  • txt String

    A string.

Returns:

String: A string formatted for the current locale.

unformat

(
  • formattedValue
)
Number

Defined in ia\utils\Formatter.js:76

Unformats a given string back to its number.

Parameters:

  • formattedValue String

    The formatted value.

Returns:

Number: The value.

Properties

decimalSeparatorTo

String

Defined in ia\utils\Formatter.js:42

The decimal separator

Default: "."

language

String

Defined in ia\utils\Formatter.js:16

The language.

Default: "en"

noDataValue

String

Defined in ia\utils\Formatter.js:25

The no data value.

Default: "No Data"

precision

Number

Defined in ia\utils\Formatter.js:34

The precision.

thousandsSeparatorTo

String

Defined in ia\utils\Formatter.js:51

The thousands separator

Default: ","