charton API / @chart-on/core / index / changeText
Function: changeText()
changeText(
close,prevClose,format,arrows?,locale?):string
Defined in: packages/core/src/series.ts:192
Candle change from the previous close as legend text, e.g. "+1.20 (+0.85%)"; with arrows, "▲ +1.20 (+0.85%)" or "▼ -1.20 (-0.85%)", nothing when unchanged. The percentage uses locale's decimal mark, digits and percent sign (default English).
Parameters
close
number
prevClose
number
format
(v) => string
arrows?
boolean = false
locale?
Pick<Localizer, "number"> & Partial<Pick<Localizer, "percent">> = englishLocalizer
Returns
string