license: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.

globalization.numberToString

Returns a number formatted as a string according to the client's user preferences.

navigator.globalization.numberToString(number, successCB, errorCB, options);

Description

It returns the formatted number string to the successCB callback with a properties object as a parameter. That object should have a value property with a String value.

If there is an error formatting the number, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING_ERROR.

options.type can be ‘decimal’, ‘percent’, or ‘currency’. The default options are {type:'decimal'}. The options parameter is optional.

Supported Platforms

Android
BlackBerry WebWorks (OS 5.0 and higher)
iPhone
Windows Phone 8

Quick Example

In the case when the browser is set to the en_US locale, this should display a popup dialog with text similar to “number: 3.142”

navigator.globalization.numberToString(
  3.1415926,
  function (number) {alert('number: ' + number.value + '\n');},
  function () {alert('Error getting number\n');},
  {type:'decimal'}
);

Full Example

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.8.0.js"></script>
    <script type="text/javascript" charset="utf-8">
                  
    function checkNumber() {
      navigator.globalization.numberToString(
        3.1415926,
        function (number) {alert('number: ' + number.value + '\n');},
        function () {alert('Error getting number\n');},
        {type:'decimal'}
      );
    }
                                        
    </script>
  </head>
  <body>
    <button onclick="checkNumber()">Click for number</button>
  </body>
</html>