IChartPictorialColumn

interface
Chart

One column descriptor produced by the pictorial geometry engine. Holds pre-computed positions for background and filled icon grids, enabling the <OrigamChartPictorial> template to render each isotype column.

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.

seriesIndex
required
number
Series index (0-based).
dataIndex
required
number
Data index within the series.
category
required
string
Category label (from categories[dataIndex] or fallback).
value
required
number
Raw numeric value from series[seriesIndex].data[dataIndex].
formatted
required
string
Pre-formatted value string.
totalSlots
required
number
Total icon slots in this column (background capacity).
filledSlots
required
number
Number of filled icon slots.
color
required
string
Resolved fill CSS colour string.
x
required
number
X translation for the column group (SVG coordinate).
y
required
number
Y translation for the column group (SVG coordinate).
iconSize
required
number
Computed icon size in SVG pixels.
visible
required
boolean
Whether this column is currently visible (legend toggle).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Accessing column descriptors from the pictorial engine

typescript