Documentation / @ripl/charts / RadialBarChartOptions
Interface: RadialBarChartOptions<TData>
Defined in: charts/src/charts/radial-bar.ts:71
Options for configuring a RadialBarChart.
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 |
color? | keyof TData | ((item) => string) | Optional accessor for a per-item colour override (otherwise a palette colour is generated). | - | charts/src/charts/radial-bar.ts:81 |
data | TData[] | The dataset to render, one concentric ring per item. | - | charts/src/charts/radial-bar.ts:73 |
format? | ValueFormatInput | Format applied to values shown as text (e.g. tooltips). | - | charts/src/charts/radial-bar.ts:97 |
gap? | number | Gap between concentric rings as a ratio of the ring thickness (0–0.9). Defaults to 0.25. | - | charts/src/charts/radial-bar.ts:89 |
innerRadius? | number | Inner hole radius as a ratio of the chart size (0–1). Defaults to 0.2. | - | charts/src/charts/radial-bar.ts:85 |
key | keyof TData | ((item) => string) | Accessor for each item's unique key, used to match rings across data updates. | - | charts/src/charts/radial-bar.ts:75 |
label? | keyof TData | ((item) => string) | Optional accessor for each item's display label (defaults to its key). | - | charts/src/charts/radial-bar.ts:79 |
legend? | ChartLegendInput | Legend configuration. Shown by default when there is more than one ring. | - | charts/src/charts/radial-bar.ts:95 |
maxValue? | number | Maximum value mapped to a full sweep (defaults to the largest value in the data). | - | charts/src/charts/radial-bar.ts:83 |
padding? | Partial<ChartPadding> | Space reserved around the chart, per edge, in pixels. | BaseChartOptions.padding | charts/src/core/chart.ts:85 |
range? | number | Angular sweep of a full-value bar, in degrees. Defaults to 360 (a full circle). | - | charts/src/charts/radial-bar.ts:87 |
rounded? | boolean | Round the ends of each value bar (and its track). Defaults to false. | - | charts/src/charts/radial-bar.ts:93 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:87 |
trackColor? | string | Colour of the faint full-length track drawn behind each value bar. Defaults to a light grey. | - | charts/src/charts/radial-bar.ts:91 |
value | NumericAccessor<TData> | Accessor for each item's numeric value, which determines its arc length. | - | charts/src/charts/radial-bar.ts:77 |