Skip to main content
Version: Next

Interface: LocalizationOptions<HorzScaleItem>

Represents options for formatting dates, times, and prices according to a locale.

Type parameters​

Name
HorzScaleItem

Hierarchy​

Properties​

timeFormatter​

• Optional timeFormatter: TimeFormatterFn<HorzScaleItem>

Override formatting of the time scale crosshair label.

Default Value

undefined

dateFormat​

• dateFormat: string

Date formatting string.

Can contain yyyy, yy, MMMM, MMM, MM and dd literals which will be replaced with corresponding date's value.

Ignored if timeFormatter has been specified.

Default Value

'dd MMM \'yy'

locale​

• locale: string

Current locale used to format dates. Uses the browser's language settings by default.

See

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#Locale_identification_and_negotiation

Default Value

navigator.language

Inherited from​

LocalizationOptionsBase.locale

priceFormatter​

• Optional priceFormatter: PriceFormatterFn

Override formatting of the price scale tick marks, labels and crosshair labels. Can be used for cases that can't be covered with built-in price formats.

See

PriceFormatCustom

Default Value

undefined

Inherited from​

LocalizationOptionsBase.priceFormatter

percentageFormatter​

• Optional percentageFormatter: PercentageFormatterFn

Override formatting of the percentage scale tick marks, labels and crosshair labels. Can be used for cases that can't be covered with built-in percentage format.

Default Value

undefined

Inherited from​

LocalizationOptionsBase.percentageFormatter