IChartSunburstProps

interface
Data Visualisation

Props for OrigamChartSunburst — the hierarchical ring chart. Extends IChartBaseProps (omitting categories). Series data must be Array<IChartSunburstDatum> carrying a nested tree. Controls inner-radius hole size, ring padding, arc label rendering and value formatting.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

innerRadius
number
0.15
Proportion of the overall radius reserved for the centre hole. 0 = full pie (no hole). 0.4 = deep donut.
ringPadding
number
1
Radial gap between consecutive rings in SVG pixels.
showLabel
boolean
true
When true, arc labels are rendered for nodes whose angular span is ≥ 0.1 rad.
yAxisFormat
(value: number) => string
Y-axis / tooltip value formatter. Receives the numeric value, returns a display string. Raw number used when omitted.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Sunburst with a large centre hole and currency formatter

vue