@angular/common

DecimalPipe

pipe

Formats a value according to digit options and locale rules. Locale determines group sizing and separator, decimal point character, and other locale-specific configurations.

  
    class DecimalPipe implements PipeTransform {
}

Formats a value according to digit options and locale rules. Locale determines group sizing and separator, decimal point character, and other locale-specific configurations.

Exported by

CommonModule

digitsInfo

The value's decimal representation is specified by the digitsInfo parameter, written in the following format:

          {minIntegerDigits}.{minFractionDigits}-{maxFractionDigits}

minIntegerDigits: The minimum number of integer digits before the decimal point. Default is 1.
minFractionDigits: The minimum number of digits after the decimal point. Default is 0.
maxFractionDigits: The maximum number of digits after the decimal point. Default is 3.

If the formatted value is truncated it will be rounded using the "to-nearest" method:

          {{3.6 | number: '1.0-0'}}<!--will output '4'-->{{-3.6 | number:'1.0-0'}}<!--will output '-4'-->

locale

locale will format a value according to locale rules. Locale determines group sizing and separator, decimal point character, and other locale-specific configurations.

When not supplied, uses the value of LOCALE_ID, which is en-US by default.

See Setting your app locale.

Example

The following code shows how the pipe transforms values according to various format specifications, where the caller's default locale is en-US.

transform

3 overloads

@paramvaluestring | number

The value to be formatted.

@paramdigitsInfostring | undefined

Sets digit and decimal representation. See more.

@paramlocalestring | undefined

Specifies what locale format rules to use. See more.

@returnsstring | null

@paramvaluenull | undefined

@paramdigitsInfostring | undefined

@paramlocalestring | undefined

@returnsnull

@paramvaluestring | number | null | undefined

@paramdigitsInfostring | undefined

@paramlocalestring | undefined

@returnsstring | null