Documentation / @ripl/charts / SunburstChartOptions
Interface: SunburstChartOptions<TData>
Defined in: charts/src/charts/sunburst.ts:79
Options for configuring a SunburstChart.
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
TData | unknown |
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
animation? | boolean | Partial<ChartAnimationOptions> | Animation configuration, or a boolean toggling all transitions. See ChartAnimationOptions. | BaseChartOptions.animation | charts/src/core/chart.ts:89 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | BaseChartOptions.autoRender | charts/src/core/chart.ts:83 |
data | SunburstNode<TData>[] | The root nodes of the hierarchy to render as concentric rings. | - | charts/src/charts/sunburst.ts:81 |
format? | ValueFormatInput | Format applied to node values shown as text (e.g. tooltips). | - | charts/src/charts/sunburst.ts:85 |
legend? | ChartLegendInput | Legend configuration, listing the top-level nodes. | - | charts/src/charts/sunburst.ts:83 |
padding? | Partial<ChartPadding> | Space reserved around the chart, per edge, in pixels. | BaseChartOptions.padding | charts/src/core/chart.ts:85 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:87 |