Functiondojo.number.format

dojo.require("dojo.number");
defined in dojo/number.js

Create a string from a Number using a known localized pattern. Formatting patterns appropriate to the locale are chosen from the CLDR as well as the appropriate symbols and delimiters. See

Usage

function (/*Number*/ value, /*dojo.number.__FormatOptions?*/ options) (view source)
parametertypedescription
valueNumberthe number to be formatted. If not a valid JavaScript number, return null.
optionsdojo.number.__FormatOptionsOptional.
fieldtypedescription
.currencyStringOptional. an [ISO4217](http://en.wikipedia.org/wiki/ISO_4217) currency code, a three letter sequence like "USD"
.localeStringOptional. override the locale used to determine formatting rules
.patternStringOptional. override [formatting pattern](http://www.unicode.org/reports/tr35/#Number_Format_Patterns) with this string
.placesNumberOptional. fixed number of decimal places to show. This overrides any information in the provided pattern.
.roundNumberOptional. 5 rounds to nearest .5; 0 rounds to nearest whole (default). -1 means don't round.
.symbolStringOptional. localized currency symbol
.typeStringOptional. choose a format type based on the locale from the following: decimal, scientific, percent, currency. decimal by default.