IChartLegendProps

interface
Chart

Props for <OrigamChartLegend> — the series-name + colour-swatch + visibility-toggle list that sits on one side of a chart. Pure renderer consuming pre-resolved IChartLegendItem[] from useChart().

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

items
required
Array<IChartLegendItem>
Pre-resolved legend entries (series + index + colour + visibility). Comes verbatim from useChart().legend.value.
position
TChartLegendPosition
Anchor of the legend block. Drives the wrapping behaviour (row on top/bottom, column on left/right).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Standalone legend wired to a chart composable

vue