Skip to main content

Interface: CustomFormatters

Charting Library.CustomFormatters

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

Properties

dateFormatter

Optional dateFormatter: CustomFormatter

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.


priceFormatterFactory

Optional priceFormatterFactory: SeriesFormatterFactory

Used to format the number displayed in the price axis


studyFormatterFactory

Optional studyFormatterFactory: CustomStudyFormatterFactory

Used to format the numbers displayed within a custom study.


tickMarkFormatter

Optional tickMarkFormatter: (date: Date, tickMarkType: TickMarkType) => string

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 declaration

▸ (date, tickMarkType): string

Parameters
NameType
dateDate
tickMarkTypeTickMarkType
Returns

string


timeFormatter

Optional timeFormatter: CustomFormatter

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