Documentation / @finchart/dom / TooltipOptions

Interface: TooltipOptions

Defined in: dom/src/tooltip.ts:6

Properties

formatRow?

optional formatRow?: RowFormat

Defined in: dom/src/tooltip.ts:17

The format for a row a series describes for itself (Series.describe — a candle's O/H/L/C/V), given the row's label and sample, so a volume can read differently from a price: (value, { label }) => label === "V" ? … : …. Absent, such rows read through formatValue like any value.

---

formatValue?

optional formatValue?: (value) => string

Defined in: dom/src/tooltip.ts:10

Row value format. Defaults to that pane's y notation (pane.formatValue).

Parameters

value

number

Returns

string

---

formatX?

optional formatX?: (x) => string

Defined in: dom/src/tooltip.ts:8

The header's x format. Defaults to the plot's — axis.x.format, else the tick strategy's own (timeTicks labels in its zone and language), else the rounded number.

Parameters

x

number

Returns

string

---

offset?

optional offset?: number

Defined in: dom/src/tooltip.ts:19

Gap from cursor to the box (px). Default 12.