charton API

---

charton API / @chart-on/core / index / legendEntryFor

Function: legendEntryFor()

legendEntryFor(series, index, settings, idle?): LegendEntry | null

Defined in: packages/core/src/legend.ts:93

A series' legend row as the legend shows it: null when the series opts out with legend: false, or is hidden with hiddenSeries: 'omit'. idle means no crosshair, so whenIdle: 'hidden' keeps only the title. The DOM legend, screenshots and valuesAt share it.

Parameters

series

Series

index

number

settings

LegendSettings

idle?

boolean = false

Returns

LegendEntry | null