Class DecorationFormatter<T>

Partial formatter implementation that applies decoration options to the resulting value.

Type parameters

T

The type of the options container.

Hierarchy

DecorationFormatter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DecorationFormatter(optionsProvider: OptionsProvider<T>, formatInfo: NumberFormatInfo): DecorationFormatter

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:34
Creates an instance that uses the resolved options from the specified options provider and applies culture-specific formatting based on the given format info.

Parameters
- optionsProvider: OptionsProvider<T>
  
  A numeric options provider whose resolved options will be used.
- formatInfo: NumberFormatInfo
  
  An instance that provides culture-specific number format information.
Returns DecorationFormatter

Properties

Private decimalOffset_

decimalOffset_: number

Private formatInfo_

formatInfo_: NumberFormatInfo

Private internalDecorators_

internalDecorators_: Indexable<string>

Private noDigits_

noDigits_: boolean

Private noLeadingZeroIntegerDigit_

noLeadingZeroIntegerDigit_: boolean

Private prefixDecorator_

prefixDecorator_: string

Private restoreNegativeSign_

restoreNegativeSign_: boolean

Private style_

style_: string

Private suffixDecorator_

suffixDecorator_: string

Private upperCase_

upperCase_: boolean

Private useGrouping_

useGrouping_: boolean

Static Private groupSeparatorRegExp_

groupSeparatorRegExp_: RegExp

Methods

Private applyDigitOptions_

applyDigitOptions_(value: number, formattedValue: string): string

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:185
Parameters
- value: number
- formattedValue: string
Returns string

Private applyExternalDecorators_

applyExternalDecorators_(formattedValue: string): string

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:251
Parameters
- formattedValue: string
Returns string

applyGrouping

applyGrouping(formattedValue: string): string

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:94
Applies the grouping option using the appropriate group separator.

Parameters
- formattedValue: string
  
  The partial resulting format value.
Returns string

A resulting format value with the applied grouping option.

applyIntegerPadding

applyIntegerPadding(value: number, formattedValue: string, paddingWidth: number): string

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:118
Applies the minimum integer digits option by padding the numeric part before the decimal separator. Also temporarily removes the current NumberFormatInfo.NegativeSign. It is restored when applyOptions finishes all decoration formatting.

Parameters
- value: number
  
  The number which is currently being formatted.
- formattedValue: string
  
  The partial resulting format value.
- paddingWidth: number
  
  The number of characters in the resulting numeric string's integral part.
Returns string

A resulting format value with the applied minimum integer digits option and without a negative sign.

Private applyInternalDecorator_

applyInternalDecorator_(numericParts: string[], index: number, decorator: string): void

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:228
Parameters
- numericParts: string[]
- index: number
- decorator: string
Returns void

Private applyInternalDecorators_

applyInternalDecorators_(formattedValue: string): string

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:208
Parameters
- formattedValue: string
Returns string

Private applyNegativeSign_

applyNegativeSign_(value: number, formattedValue: string): string

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:264
Parameters
- value: number
- formattedValue: string
Returns string

applyOptions

applyOptions(value: number, formattedValue: string): string

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:68
Applies negative sign position and symbol, removal of the leading zero, internal and external decorators to the formatted value.

Parameters
- value: number
  
  The number which is currently being formatted.
- formattedValue: string
  
  The partial resulting format value.
Returns string

The fully formatted value.

applyUppercase

applyUppercase(formattedValue: string): string

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:83
Applies the uppercase option for some standard specifiers that require it.

Parameters
- formattedValue: string
  
  The partial resulting format value.
Returns string

A resulting format value with the applied uppercase option.

getDecimalSeparator

getDecimalSeparator(formatInfo?: NumberFormatInfo): string

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:143
Returns the appropriate decimal separator symbol depending on the available format info and style option.

Parameters
- Optional formatInfo: NumberFormatInfo
  
  An overriding format info instance to be used.
Returns string

getGroupSeparator

getGroupSeparator(formatInfo?: NumberFormatInfo): string

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:156
Returns the appropriate group separator symbol depending on the available format info and style option.

Parameters
- Optional formatInfo: NumberFormatInfo
  
  An overriding format info instance to be used.
Returns string

Private isCurrency_

isCurrency_(): boolean

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:165
Returns boolean

Private removeNegativeSign_

removeNegativeSign_(value: number, formattedValue: string): string

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:172
Parameters
- value: number
- formattedValue: string
Returns string

Private shouldRemoveLeadingZero_

shouldRemoveLeadingZero_(value: number): boolean

- Defined in core/Globalization/Numeric/DecorationFormatter.ts:196
Parameters
- value: number
Returns boolean

Generated using TypeDoc