JSPM

  • Created
  • Published
  • Downloads 652
  • Score
    100M100P100Q11331F
  • License MIT

Shorthand formatters for common number types.

Package Exports

  • d3plus-format

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (d3plus-format) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

d3plus-format

NPM Release Build Status Dependency Status Gitter

Shorthand formatters for common number types.

Installing

If you use NPM, run npm install d3plus-format --save. Otherwise, download the latest release. The released bundle supports AMD, CommonJS, and vanilla environments. You can also load directly from d3plus.org:

<script src="https://d3plus.org/js/d3plus-format.v0.1.full.min.js"></script>

API Reference

  • formatAbbreviate - Formats a number to an appropriate number of decimal places and rounding, adding suffixes if applicable (ie. 1200000 to "1.2M").

d3plus.formatAbbreviate(n, locale) <>

Formats a number to an appropriate number of decimal places and rounding, adding suffixes if applicable (ie. 1200000 to "1.2M").

This is a global function.

Param Type Description
n Number | String The number to be formatted.
locale Object | String The locale config to be used. If value is an object, the function will format the numbers according the object. The object must include suffixes, delimiter and currency properties.

Documentation generated on Thu, 18 Apr 2019 14:13:54 GMT