IChartSunburstNode
interface
Data Visualisation
Fully-resolved node produced by the sunburst geometry engine. Every field is definite — defaults and inherited values have been applied. Contains SVG arc coordinates, resolved colour and the label rendering mode decision.
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.
- idrequiredstring
- Unique path key built as "Root > Branch > Leaf". Used as the v-for :key.
- namerequiredstring
- Display name — copy of datum.name.
- valuerequirednumber
- Resolved numeric value — sum of children when absent in the source datum.
- depthrequirednumber
- Tree depth; root-level nodes are 0.
- rootIndexrequirednumber
- Index within the root-level array — used for colour inheritance down the tree.
- startAnglerequirednumber
- Arc start angle in radians [0, 2π).
- endAnglerequirednumber
- Arc end angle in radians (0, 2π].
- innerRrequirednumber
- Inner ring radius for this node in SVG user units.
- outerRrequirednumber
- Outer ring radius for this node in SVG user units.
- drequiredstring
- Pre-computed SVG <path d="…"> for the arc segment.
- colorrequiredstring
- Resolved CSS colour string — intent variable or raw value.
- visiblerequiredboolean
- Whether this node is currently visible (driven by legend toggle on root-level entries).
- pathrequiredstring
- Full ancestor path string "Root > Branch > Leaf" — shown in the tooltip.
- labelModerequiredTChartSunburstLabelMode
- How the label for this node should be rendered. 'inline' — centred inside the arc. 'rotated' — tangentially along the arc midpoint. 'leader' — outside the chart with a leader line.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Reading IChartSunburstNode from the tooltip slot