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.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- seriesIndexrequirednumber
- Series index (0-based).
- dataIndexrequirednumber
- Data index within the series.
- categoryrequiredstring
- Category label (from categories[dataIndex] or fallback).
- valuerequirednumber
- Raw numeric value from series[seriesIndex].data[dataIndex].
- formattedrequiredstring
- Pre-formatted value string.
- totalSlotsrequirednumber
- Total icon slots in this column (background capacity).
- filledSlotsrequirednumber
- Number of filled icon slots.
- colorrequiredstring
- Resolved fill CSS colour string.
- xrequirednumber
- X translation for the column group (SVG coordinate).
- yrequirednumber
- Y translation for the column group (SVG coordinate).
- iconSizerequirednumber
- Computed icon size in SVG pixels.
- visiblerequiredboolean
- 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