Skip to content

Documentation / @ripl/charts / SunburstNode

Interface: SunburstNode<TData>

Defined in: charts/src/charts/sunburst.ts:63

A node in a sunburst hierarchy with optional nested children and an optional typed datum.

Type Parameters

Type ParameterDefault type
TDataunknown

Properties

PropertyTypeDescriptionDefined in
children?SunburstNode<TData>[]Child nodes rendered in the next ring outward, within this node's angular range.charts/src/charts/sunburst.ts:73
color?stringOptional colour override; child nodes inherit their parent's colour when omitted.charts/src/charts/sunburst.ts:71
data?TDataArbitrary datum carried through to segment interaction events.charts/src/charts/sunburst.ts:75
idstringUnique identifier for the node.charts/src/charts/sunburst.ts:65
labelstringDisplay label shown in the legend and tooltips.charts/src/charts/sunburst.ts:67
valuenumberThe node's numeric value, which determines its angular extent.charts/src/charts/sunburst.ts:69