Documentation / @finchart/dom / LegendOptions

Interface: LegendOptions

Defined in: dom/src/legend.ts:16

Properties

formatRow?

optional formatRow?: RowFormat

Defined in: dom/src/legend.ts:22

The format for a row a series describes for itself (a candle's O/H/L/C/V) — see tooltip's formatRow. Absent, such rows read through formatValue.

---

formatValue?

optional formatValue?: (value) => string

Defined in: dom/src/legend.ts:20

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

Parameters

value

number

Returns

string

---

pane?

optional pane?: LegendPane

Defined in: dom/src/legend.ts:18

Which pane's series. Defaults to mainPane.