Constructors

Section titled "Constructors"

BaseFormatter 

new BaseFormatter(): BaseFormatter

Returns BaseFormatter

Methods

Section titled "Methods"

formatCurrency

Section titled "formatCurrency"

Format number as a currency based on locale

 
formatCurrency(value: string | number | null | undefined, locale: string, display: string, currencyCode: string, digitsInfo: string): string

Defined in projects/igniteui-angular/core/src/core/i18n/formatters/formatter-base.ts:103

Parameters

  • value: string | number | null | undefined
  • locale: string
  • display: string
  • currencyCode: string
  • digitsInfo: string

Returns string

formatDate

Section titled "formatDate"

Format provided date to reflect locales format. Similar to Angular's formatDate.

 
formatDate(value: string | number | Date | null | undefined, format: string, locale: string, timezone: string): string

Defined in projects/igniteui-angular/core/src/core/i18n/formatters/formatter-base.ts:80

Parameters

  • value: string | number | Date | null | undefined
  • format: string
  • locale: string
  • timezone: string

Returns string

formatNumber

Section titled "formatNumber"

Format number value based on locale

 
formatNumber(value: string | number | null | undefined, locale: string, digitsInfo: string): string

Defined in projects/igniteui-angular/core/src/core/i18n/formatters/formatter-base.ts:87

Parameters

  • value: string | number | null | undefined
  • locale: string
  • digitsInfo: string

Returns string

formatPercent

Section titled "formatPercent"

Format number value as percent based on locale

 
formatPercent(value: string | number | null | undefined, locale: string, digitsInfo: string): string

Defined in projects/igniteui-angular/core/src/core/i18n/formatters/formatter-base.ts:95

Parameters

  • value: string | number | null | undefined
  • locale: string
  • digitsInfo: string

Returns string

getCurrencyCode

Section titled "getCurrencyCode"

Retrieve the currency code of the locale provided. Angular provides locale data for them, if using that. When using Intl, it should be user defined and defaults to USD.

 
getCurrencyCode(locale: string, overrideCode: string): string

Defined in projects/igniteui-angular/core/src/core/i18n/formatters/formatter-base.ts:116

Parameters

  • locale: string
  • overrideCode: string

Returns string

getCurrencySymbol

Section titled "getCurrencySymbol"

Get the currency symbol based on a currency code.

 
getCurrencySymbol(currencyCode: string, locale: string, currencyDisplay: keyof NumberFormatOptionsCurrencyDisplayRegistry): string

Defined in projects/igniteui-angular/core/src/core/i18n/formatters/formatter-base.ts:125

Parameters

  • currencyCode: string
  • locale: string
  • currencyDisplay: keyof NumberFormatOptionsCurrencyDisplayRegistry

Returns string

getFormatOptions

Section titled "getFormatOptions"

Get Intl options based on format provided:

date and time formats - short, medium, long, full

date formats - shortDate, mediumDate, longDate, fullDate

time formats - shortTime, mediumTime, longTime, fullTime

 
getFormatOptions(format: string | null | undefined): DateTimeFormatOptions | null

Defined in projects/igniteui-angular/core/src/core/i18n/formatters/formatter-base.ts:51

Parameters

  • format: string | null | undefined

Returns DateTimeFormatOptions | null

getLocaleDateTimeFormat

Section titled "getLocaleDateTimeFormat"

Returns the date and time format based on a provided locale and options.

 
getLocaleDateTimeFormat(locale: string, forceLeadingZero: boolean, options: DateTimeFormatOptions): string

Defined in projects/igniteui-angular/core/src/core/i18n/formatters/formatter-base.ts:73

Parameters

  • locale: string
  • forceLeadingZero: boolean
  • options: DateTimeFormatOptions

Returns string

getLocaleFirstDayOfWeek

Section titled "getLocaleFirstDayOfWeek"

Get first day of the week. Angular's default: 0...6. Intl default: 1...7.

 
getLocaleFirstDayOfWeek(locale: string): number

Defined in projects/igniteui-angular/core/src/core/i18n/formatters/formatter-base.ts:138

Parameters

  • locale: string

Returns number

verifyLocale

Section titled "verifyLocale" 
verifyLocale(locale: string): string

Defined in projects/igniteui-angular/core/src/core/i18n/formatters/formatter-base.ts:30

Parameters

  • locale: string

Returns string