Documentation / @ripl/charts / PolarScatterChartOptions
Interface: PolarScatterChartOptions<TData> ​
Defined in: charts/src/charts/polar-scatter.ts:112
Options for configuring a PolarScatterChart.
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 |
data | TData[] | The dataset plotted across all series. | - | charts/src/charts/polar-scatter.ts:114 |
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 radial values shown as text (tooltips + ring labels). | - | charts/src/charts/polar-scatter.ts:126 |
labels? | ChartDataLabelsInput | Show each marker's radial value beside it, just above by default (true/false, an anchor, or detailed label options). Off by default. | - | charts/src/charts/polar-scatter.ts:128 |
legend? | ChartLegendInput | Legend configuration. Shown by default when there is more than one series. | - | charts/src/charts/polar-scatter.ts:124 |
levels? | number | Number of concentric value rings. Defaults to 4. | - | charts/src/charts/polar-scatter.ts:120 |
max? | number | The value mapped to the outer radius (defaults to the largest radius value in the data). | - | charts/src/charts/polar-scatter.ts:118 |
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 |
sectors? | number | Number of angular spokes/labels around the circle. Defaults to 8. | - | charts/src/charts/polar-scatter.ts:122 |
series | PolarScatterSeriesOptions<TData>[] | The series to render, each mapping the data to angle/radius positions. | - | charts/src/charts/polar-scatter.ts:116 |
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 |