Formatting numbers for currency display and more.

Formatting numbers for currency display and more.

Formatting numbers so they conform to a specific format can be deceivingly tricky. For example, one of the most common tasks is to format a number for currency display- an integer followed by two decimals. There are more subtitles in such a task than many might think. In this tutorial, I'll discuss formatting numbers in JavaScript, such as number rounding, formatting a number for currency display, and more.

Number rounding in JavaScript

Lets first talk about number rounding in JavaScript. JavaScript accomplishes this with the following method:

Math.round(x)

Using it, any supplied argument is rounded off to the nearest integer, and using the ".5" up rule. For example:

Math.round(25.9) //returns 26
Math.round(25.2) //returns 25
Math.round(-2.58) //returns -3

If purging numbers of decimals is all that you require, class dismissed!

Taking things a few decimal further

Formatting numbers to specific decimal points still entails Math.round(), but padded with a little multiplication and division. See if you can identify the magic formula involved, with the below examples:

var original=28.453
1) //round "original" to two decimals
var result=Math.round(original*100)/100  //returns 28.45
2) // round "original" to 1 decimal
var result=Math.round(original*10)/10  //returns 28.5
3) //round 8.111111 to 3 decimals
var result=Math.round(8.111111*1000)/1000  //returns 8.111

In case you haven't picked up on it, the formula to round any number to x decimal points is:

1) Multiple the original number by 10^x (10 to the power of x)
2) Apply Math.round() to the result
3) Divide result by 10^x

Formatting numbers for currency display

Now, lets move on to formatting numbers for currency display in JavaScript. You may be tempted to simply use number rounding to first shift the number's decimal places (via multiplication), round it, then shift the decimal back (via division) to pound the number into your hard earned dollar, though that won't work in many cases. For example, consider the number 120. Number rounding certainly won't get you to 120.00.

To easily format numbers for a specific number of trailing decimals or total digits (aka padding), JavaScript 1.5 introduces the below two nifty methods:

Methods Description
Number.toFixed(x) Formats any number for "x" number of trailing decimals. The number is rounded up, and "0"s are used after the decimal point if needed to create the desired decimal length.
Number.toPrecision(x) Formats any number so it is of "x" length. Also called significant digits. A decimal point and "0"s are used if needed to create the desired length.

Number.toFixed()

The best way to see all the subtleties of toFixed() is to see it in action:

var profits=2489.8237
profits.toFixed(3) //returns 2489.824 (round up)
profits.toFixed(2) //returns 2489.82
profits.toFixed(7) //returns 2489.8237000 (padding)

Displaying any number in currency format can't get any easier!

Number.toPrecision()

To toPrecision() now:

var anumber=123.45
anumber.toPrecision(6) //returns 123.450 (padding)
anumber.toPrecision(4) //returns 123.5 (round up)
anumber.toPrecision(2) //returns 1.2e+2 (you figure it out!)

toPrecision() is useful if your number must be of a certain length.

Browser considerations

Now, as noted, the last two methods above are JavaScript 1.5 methods. What this means is that they'll only work in IE5.5+ and NS6+. The issue of legacy browsers not performing the desired formatting operation not withstanding, how do you ensure that these two methods at least degrade well? Well, by using method detection in your code. For example:

var profits=2489.8237
if (profits.toFixed) //if browser supports toFixed() method
profits.toFixed(2)

For those of you who also need to ensure legacy browsers such as IE5 also perform the desired number formatting operation, well, then it's time to roll your own function.

Comments

The homerolled function

Well, the toFixed and toPrecision methods are affected by rounding problems and sometimes returns the original number instead of a formatted one in among other browsers ie5.5w. I wrote this for the FAQ on CF, so you'll probably recognise it.

Number.prototype.toDecimals=function(n){
    n=(isNaN(n))?
        2:
        n;
    var
        nT=Math.pow(10,n);
    function pad(s){
            s=s||'.';
            return (s.length>n)?
                s:
                pad(s+'0');
    }
    return (isNaN(this))?
        this:
        (new String(
            Math.round(this*nT)/nT
        )).replace(/(\.\d*)?$/,pad);
}
// David

Examples

These examples serve both to show how to use the formatting functions and as a test to see if they function correctly on your browser. If they do not function correctly - please let me know, and I will see what I can do about it.

fmt00

To insert leading zero for integers 0-9. No change will take place for integers > 9.

The code to do this is:

  <SCRIPT LANGUAGE="JavaScript">
  <!--
   function tst00(){
    var a = new ToFmt(document.fm1.fta1.value);
    document.fm1.fta2.value=a.fmt00();
   }
  // -->
  </SCRIPT>

and the HTML for the form is:

  <FORM NAME="fm1">
  Enter a postive integer:
  <INPUT TYPE="TEXT" SIZE=3 NAME="fta1">
  <INPUT TYPE="BUTTON" VALUE="Format!" onClick="tst00();return true;">
  Result:
  <INPUT TYPE="TEXT" SIZE=3 NAME="fta2">
  </FORM>

The function first creates a new ToFmt object with the contents of the first text field of the form (named fta1), and sets the value of the second text field to the result of the fmt00() method invoked on the ToFmt object created.

problem

there's a problem using Math.round with floating number / decimal
multiplication has a little limitation
try to multiply 1035.225 * 100
it will show you 103522.499999998 instead of 103522.5
when you round it with Math.round it will show you 103522 not 103523
that's why you'll get a wrong result

here's the case:
decimal rounding : 1035.225 --> 1035.22
decimal rounding : 135.225 --> 135.23
you can see how much is the difference
any suggestion?