Documentation / @ripl/charts / RadialBarChartOptions
Interface: RadialBarChartOptions<TData> ​
Defined in: charts/src/charts/radial-bar.ts:83
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:128 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | BaseChartOptions.autoRender | charts/src/core/chart.ts:122 |
colorBy? | keyof TData | ((item) => string) | Optional accessor for a per-item color override (otherwise a palette color is generated). | - | charts/src/charts/radial-bar.ts:93 |
data | TData[] | The dataset to render, one concentric ring per item. | - | charts/src/charts/radial-bar.ts:85 |
description? | string | Accessible description announced by screen readers (sets the rendering element's ARIA label). Defaults to the title text. | BaseChartOptions.description | charts/src/core/chart.ts:132 |
format? | ValueFormatInput | Format applied to values shown as text (e.g. tooltips). | - | charts/src/charts/radial-bar.ts:109 |
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:101 |
innerRadius? | number | Inner hole radius as a ratio of the chart size (0–1). Defaults to 0.2. | - | charts/src/charts/radial-bar.ts:97 |
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:87 |
label? | keyof TData | ((item) => string) | Optional accessor for each item's display label (defaults to its key). | - | charts/src/charts/radial-bar.ts:91 |
labels? | ChartDataLabelsInput | Show each ring's value just past the end of its bar, at the ring's mid-radius (true/false or detailed label options). Off by default. | - | charts/src/charts/radial-bar.ts:111 |
legend? | ChartLegendInput | Legend configuration. Shown by default when there is more than one ring. | - | charts/src/charts/radial-bar.ts:107 |
max? | number | Maximum value mapped to a full sweep (defaults to the largest value in the data). | - | charts/src/charts/radial-bar.ts:95 |
padding? | PaddingInput | Space reserved around the chart, in pixels. A single number applies to all four edges; a [top, right, bottom, left] tuple or a partial { top, right, bottom, left } object sets individual edges, leaving unspecified edges at the default. Defaults to 16. | BaseChartOptions.padding | charts/src/core/chart.ts:124 |
range? | number | Angular sweep of a full-value bar, in degrees. Defaults to 360 (a full circle). | - | charts/src/charts/radial-bar.ts:99 |
rounded? | boolean | Round the ends of each value bar (and its track). Defaults to false. | - | charts/src/charts/radial-bar.ts:105 |
theme? | string | Theme | Theme for this chart: a registered name ('light'/'dark'/'auto'), or a Theme. Falls back to the module default (see setDefaultTheme). | BaseChartOptions.theme | charts/src/core/chart.ts:130 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:126 |
trackColor? | string | Color of the faint full-length track drawn behind each value bar. Defaults to a light gray. | - | charts/src/charts/radial-bar.ts:103 |
value | NumericAccessor<TData> | Accessor for each item's numeric value, which determines its arc length. | - | charts/src/charts/radial-bar.ts:89 |