Documentation / @ripl/charts / PieChartOptions
Interface: PieChartOptions<TData>
Defined in: charts/src/charts/pie.ts:84
Options for configuring a PieChart.
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/pie.ts:94 |
data | TData[] | The dataset to render, one segment per item. | - | charts/src/charts/pie.ts:86 |
format? | ValueFormatInput | Format applied to segment values shown as text (e.g. tooltips). | - | charts/src/charts/pie.ts:106 |
innerRadius? | number | Inner hole radius (donut). A value <= 1 is a fraction of the outer radius; larger values are absolute pixels. Defaults to 0 (a solid pie). | - | charts/src/charts/pie.ts:96 |
key | keyof TData | ((item) => string) | Accessor for each item's unique key, used to match segments across data updates. | - | charts/src/charts/pie.ts:88 |
label | keyof TData | ((item) => string) | Accessor for each item's display label (shown in the legend and segment labels). | - | charts/src/charts/pie.ts:92 |
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/pie.ts:104 |
legend? | ChartLegendInput | Legend configuration. Shown by default; pass false to hide. | - | charts/src/charts/pie.ts:98 |
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 its proportional arc angle. | - | charts/src/charts/pie.ts:90 |