Documentation / @ripl/charts / PolarAreaChartOptions
Interface: PolarAreaChartOptions<TData>
Defined in: charts/src/charts/polar-area.ts:87
Options for configuring a PolarAreaChart.
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/polar-area.ts:97 |
data | TData[] | The dataset to render, one equal-angle segment per item. | - | charts/src/charts/polar-area.ts:89 |
format? | ValueFormatInput | Format applied to segment values shown as text (e.g. tooltips). | - | charts/src/charts/polar-area.ts:115 |
innerRadiusRatio? | number | Inner radius ratio (0 - 1). Defaults to 0.15 | - | charts/src/charts/polar-area.ts:99 |
key | keyof TData | ((item) => string) | Accessor for each item's unique key, used to match segments across data updates. | - | charts/src/charts/polar-area.ts:91 |
label | keyof TData | ((item) => string) | Accessor for each item's display label (shown in the legend and segment labels). | - | charts/src/charts/polar-area.ts:95 |
labels? | ChartSegmentLabelsInput | Segment labels. Hidden by default (the legend is shown by default). true shows labels inside each segment; 'outside' places them beyond the arc with a leader line; a full object customises position/font/colour. | - | charts/src/charts/polar-area.ts:113 |
legend? | ChartLegendInput | Legend showing each segment. Shown by default (more than one segment); pass false to hide. | - | charts/src/charts/polar-area.ts:107 |
levels? | number | Number of concentric grid rings. Defaults to 4 | - | charts/src/charts/polar-area.ts:105 |
maxRadiusRatio? | number | Maximum radius ratio (0 - 0.5). Defaults to 0.45 (similar to pie chart). | - | charts/src/charts/polar-area.ts:101 |
padAngle? | number | Padding angle between segments in radians. Defaults to 0.02 | - | charts/src/charts/polar-area.ts:103 |
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 |
value | NumericAccessor<TData> | Accessor for each item's numeric value, which determines the segment's radial extent. | - | charts/src/charts/polar-area.ts:93 |