Core Function FmtNumber

FmtNumber( <number>, <decimals>, <dec_point>, <thousands_sep> )

Description

Format a number with grouped thousands.

This function accepts either one, two, or four parameters (not three):

If only one parameter is given, number will be formatted without decimals, but with a comma (",") between every group of thousands.

If two parameters are given, number will be formatted with decimals decimals with a dot (".") in front, and a comma (",") between every group of thousands.

If all four parameters are given, number will be formatted with decimals decimals, dec_point instead of a dot (".") before the decimals and thousands_sep instead of a comma (",") between every group of thousands.

Parameters

number

The number being formatted.

decimals

Sets the number of decimal points.

Default: "0"

dec_point

Sets the separator for the decimal point.

Default: "."

thousands_sep

Sets the thousands separator.

Default: ","

Return Value

A formatted version of number.

Remarks

None.

Example

$number = 1234.56;
 
// english notation (default)
say fmtNumber($number);
// 1,235
 
// French notation
say fmtNumber($number, 2, ',', ' ');
// 1 234,56
 
// english notation without thousands separator
$number = 1234.5678;
say fmtNumber($number, 2, '.', '');
// 1234.57