Skip to main content

CustomFormatters

Interface

Formatters used to adjust the displayed format of the date and time values.

Properties​

dateFormatter​

Optional

Used to format the date displayed over the timescale when hovering over a chart. Note that by declaring this formatter all the default ones defined in Chart settings/Scales/Date format will display the exact same outcome as the formatter.

Type​

​CustomFormatter

priceFormatterFactory​

Optional

Used to format the number displayed in the price axis

Type​

​SeriesFormatterFactory

studyFormatterFactory​

Optional

Used to format the numbers displayed within a custom study.

Type​

​CustomStudyFormatterFactory

tickMarkFormatter​

Optional

Used to format date displayed in the time axis Remark: tickMarkFormatter must display the UTC date, and not the date corresponding to your local time zone.

Type​

​(date: Date, tickMarkType: TickMarkType) => string

Type declaration​

Signature​

(date: Date, tickMarkType: TickMarkType) => string
Parameters​
NameType
dateDate
tickMarkTypeTickMarkType
Returns​

​string

timeFormatter​

Optional

Used to format the time displayed in the bottom toolbar (time zone)

Type​

​CustomFormatter