Documentation / @finchart/react / TooltipProps

Interface: TooltipProps

Defined in: react/src/components/tooltip.tsx:7

Properties

formatRow?

optional formatRow?: RowFormat

Defined in: react/src/components/tooltip.tsx:13

The format for a row a series describes for itself (a candle's O/H/L/C/V), with { label, sample } — so V can read as a volume. Absent, such rows read through formatValue.

---

formatValue?

optional formatValue?: (value) => string

Defined in: react/src/components/tooltip.tsx:11

Value format for each row. Defaults to two decimals.

Parameters

value

number

Returns

string

---

formatX?

optional formatX?: (x) => string

Defined in: react/src/components/tooltip.tsx:9

The x format for the header. Leave it out and the header speaks the axis's clock — axis.x.format, else the tick strategy's (timeTicks knows its zone), else the rounded number.

Parameters

x

number

Returns

string

---

offset?

optional offset?: number

Defined in: react/src/components/tooltip.tsx:15

Gap between the cursor and the box (px), kept on whichever side the box sits. Defaults to 12.