lib/yuilib/3.13.0/datatype-number-format/datatype-number-format.js

   1 /*
   2 YUI 3.13.0 (build 508226d)
   3 Copyright 2013 Yahoo! Inc. All rights reserved.
   4 Licensed under the BSD License.
   5 http://yuilibrary.com/license/
   6 */
   7
   8 YUI.add('datatype-number-format', function (Y, NAME) {
   9
  10 /**
  11  * The Number Utility provides type-conversion and string-formatting
  12  * convenience methods for Numbers.
  13  *
  14  * @module datatype-number
  15  * @main datatype-number
  16  */
  17
  18 /**
  19  * Format number submodule.
  20  *
  21  * @module datatype-number
  22  * @submodule datatype-number-format
  23  */
  24
  25 /**
  26  * Number provides a set of utility functions to operate against Number objects.
  27  *
  28  * @class Number
  29  * @static
  30  */
  31 var LANG = Y.Lang;
  32
  33 Y.mix(Y.namespace("Number"), {
  34      /**
  35      * Takes a Number and formats to string for display to user.
  36      *
  37      * @method format
  38      * @param data {Number} Number.
  39      * @param config {Object} (Optional) Optional configuration values:
  40      *  <dl>
  41      *   <dt>prefix {HTML}</dd>
  42      *   <dd>String prepended before each number, like a currency designator "$"</dd>
  43      *   <dt>decimalPlaces {Number}</dd>
  44      *   <dd>Number of decimal places to round. Must be a number 0 to 20.</dd>
  45      *   <dt>decimalSeparator {HTML}</dd>
  46      *   <dd>Decimal separator</dd>
  47      *   <dt>thousandsSeparator {HTML}</dd>
  48      *   <dd>Thousands separator</dd>
  49      *   <dt>suffix {HTML}</dd>
  50      *   <dd>String appended after each number, like " items" (note the space)</dd>
  51      *  </dl>
  52      * @return {HTML} Formatted number for display. Note, the following values
  53      * return as "": null, undefined, NaN, "".
  54      */
  55     format: function(data, config) {
  56         if(LANG.isNumber(data)) {
  57             config = config || {};
  58
  59             var isNeg = (data < 0),
  60                 output = data + "",
  61                 decPlaces = config.decimalPlaces,
  62                 decSep = config.decimalSeparator || ".",
  63                 thouSep = config.thousandsSeparator,
  64                 decIndex,
  65                 newOutput, count, i;
  66
  67             // Decimal precision
  68             if(LANG.isNumber(decPlaces) && (decPlaces >= 0) && (decPlaces <= 20)) {
  69                 // Round to the correct decimal place
  70                 output = data.toFixed(decPlaces);
  71             }
  72
  73             // Decimal separator
  74             if(decSep !== "."){
  75                 output = output.replace(".", decSep);
  76             }
  77
  78             // Add the thousands separator
  79             if(thouSep) {
  80                 // Find the dot or where it would be
  81                 decIndex = output.lastIndexOf(decSep);
  82                 decIndex = (decIndex > -1) ? decIndex : output.length;
  83                 // Start with the dot and everything to the right
  84                 newOutput = output.substring(decIndex);
  85                 // Working left, every third time add a separator, every time add a digit
  86                 for (count = 0, i=decIndex; i>0; i--) {
  87                     if ((count%3 === 0) && (i !== decIndex) && (!isNeg || (i > 1))) {
  88                         newOutput = thouSep + newOutput;
  89                     }
  90                     newOutput = output.charAt(i-1) + newOutput;
  91                     count++;
  92                 }
  93                 output = newOutput;
  94             }
  95
  96             // Prepend prefix
  97             output = (config.prefix) ? config.prefix + output : output;
  98
  99             // Append suffix
 100             output = (config.suffix) ? output + config.suffix : output;
 101
 102             return output;
 103         }
 104         // Not a Number, just return as string
 105         else {
 106             return (LANG.isValue(data) && data.toString) ? data.toString() : "";
 107         }
 108     }
 109 });
 110
 111 Y.namespace("DataType");
 112 Y.DataType.Number = Y.Number;
 113
 114
 115 }, '3.13.0');