Class InfoFormatter<T>

Base formatter implementation that applies raw culture information formatting to a numeric value.

Type parameters

T

The type of the options container.

Hierarchy

InfoFormatter
- IntlFormatter

Implements

CustomFormatter

Index

Constructors

constructor

Properties

Methods

Object literals

formatters_

Constructors

constructor

new InfoFormatter(optionsProviderConstructor: object, formatInfo: NumberFormatInfo, options?: T): InfoFormatter

- Defined in core/Globalization/Numeric/InfoFormatter.ts:34
Creates an instance with base formatting options and initializes an options provider that resolves concrete format options.

Parameters
- optionsProviderConstructor: object
  
  A numeric options provider constructor which will be used to resolve options.
  - constructor: function
    - new __type(baseOptions: T): __type
    - Defined in core/Globalization/Numeric/InfoFormatter.ts:42
      Parameters
      - baseOptions: T
      Returns __type
- formatInfo: NumberFormatInfo
  
  An instance that can provide custom numeric format information.
- Optional options: T
  
  A base options object that can be overridden by resolved options.
Returns InfoFormatter

Properties

Private baseOptions_

baseOptions_: T

Protected decorationFormatter

decorationFormatter: DecorationFormatter<T>

Protected formatInfo

formatInfo: NumberFormatInfo

Private optionsProviderConstructor_

optionsProviderConstructor_: object

Type declaration

constructor: function
- new __type(baseOptions: T): __type
- - Defined in core/Globalization/Numeric/InfoFormatter.ts:34
  Parameters
  - baseOptions: T
  Returns __type

Private optionsProvider_

optionsProvider_: OptionsProvider<T>

Protected resolvedOptions

resolvedOptions: T

Private value_

value_: number

Methods

Private applyDecimalFormat_

applyDecimalFormat_(): string

- Defined in core/Globalization/Numeric/InfoFormatter.ts:133
Returns string

Protected applyOptions

applyOptions(value: number): string

- Defined in core/Globalization/Numeric/InfoFormatter.ts:77
Applies all resolved format options to the number.

Parameters
- value: number
  
  The number to format.
Returns string

A resulting format value with applied format options.

Private cleanup_

cleanup_(): void

- Defined in core/Globalization/Numeric/InfoFormatter.ts:126
Returns void

format

format(format: string, value: number): string

- Defined in core/Globalization/Numeric/InfoFormatter.ts:63
Converts the number to an equivalent string representation using specified format and culture formatting information.

Parameters
- format: string
  
  A format string containing formatting specifications.
- value: number
  
  The number to format.
Returns string

The formatted numeric value.

Private innerFormat_

innerFormat_(format: string, value: number): string

- Defined in core/Globalization/Numeric/InfoFormatter.ts:100
Parameters
- format: string
- value: number
Returns string

Private setValue_

setValue_(value: number): void

- Defined in core/Globalization/Numeric/InfoFormatter.ts:116
Parameters
- value: number
Returns void

Object literals

Private formatters_

formatters_: object

currency

currency(): string

- Defined in core/Globalization/Numeric/InfoFormatter.ts:155
The currency format is not supported by this basic instance.

Returns string

decimal

decimal(): string

- Defined in core/Globalization/Numeric/InfoFormatter.ts:160
The decimal format converts a number to a string of decimal digits (0-9), prefixed by a minus sign if the number is negative.

Returns string

exponential

exponential(): string

- Defined in core/Globalization/Numeric/InfoFormatter.ts:171
The exponential format converts a number to a string of the form "-d.ddd…E+ddd" or "-d.ddd…e+ddd".

Returns string

fixedPoint

fixedPoint(): string

- Defined in core/Globalization/Numeric/InfoFormatter.ts:180
The fixed-point format converts a number to a string of the form "-ddd.ddd…" where each "d" indicates a digit (0-9).

Returns string

general

general(): string

- Defined in core/Globalization/Numeric/InfoFormatter.ts:189
The general format converts a number to the most compact of either fixed-point or scientific notation, depending on the type of the number and whether a precision specifier is present. Fixed-point notation is used if the exponent that would result from expressing the number in scientific notation is greater than -5 and less than the precision specifier; otherwise, scientific notation is used.

Returns string

hex

hex(): string

- Defined in core/Globalization/Numeric/InfoFormatter.ts:226
The hexadecimal format converts a number to a string of hexadecimal digits.

Returns string

number

number(): string

- Defined in core/Globalization/Numeric/InfoFormatter.ts:210
The numeric format converts a number to a string of the form "-d,ddd,ddd.ddd…", where "-" indicates a negative number symbol if required, "d" indicates a digit (0-9), "," indicates a group separator, and "." indicates a decimal point symbol.

Returns string

percent

percent(): string

- Defined in core/Globalization/Numeric/InfoFormatter.ts:215
The percent format multiplies a number by 100 and converts it to a string that represents a percentage.

Returns string

roundTrip

roundTrip(): string

- Defined in core/Globalization/Numeric/InfoFormatter.ts:221
The round-trip format is used to ensure that a numeric value that is converted to a string will be parsed back into the same numeric value.

Returns string

Generated using TypeDoc