IChartSeries

interface
Data Visualisation

A single data series rendered by OrigamChart. The data field accepts either a flat number array (values aligned to categories by index) or an object array of IChartSeriesPoint for explicit x/y coordinates — required for scatter and sparse data.

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.

name
required
string
Display name shown in the legend and used as the screen-reader description for the series.
data
required
Array<number> | Array<IChartSeriesPoint>
Series data. Numbers are aligned to categories[index]. Objects carry their own X coordinate — required for scatter and irregular sampling.
color
TIntent | string
Intent token (primary, success, …) or raw CSS colour (#ff0080, rgb(…)). When absent the chart pulls the next colour from colorScheme cycling by series index.
visible
boolean
true
Whether the series is currently visible. Driven from legend-click → series-toggle. Default true.
type
TChartType
Override the chart-level type for this series only — enables mix charts (a column chart with a line overlay).
yAxis
0 | 1
0
Which Y axis this series is mapped to. 0 = left primary axis, 1 = right secondary axis. Only meaningful for cartesian family charts.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Defining a line series and a column series on a mix chart

typescript