IChartSunburstDatum
interface
Data Visualisation
A single datum node in the sunburst tree. Internal nodes may omit value — it will be auto-computed as the sum of direct children. The children array forms the next ring outward in the chart.
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.
- namerequiredstring
- Display name for the node, shown in arc labels and the tooltip.
- valuenumber
- Numeric value. Optional for internal nodes — if absent it equals the sum of direct children.
- colorTIntent | string
- Override colour for this specific node. Accepts a design-system intent token or any raw CSS colour string.
- childrenArray<IChartSunburstDatum>
- Child nodes — each child appears in the next ring outward from this node.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Two-level sunburst dataset