Interface: PolarOptions
Options every polar function takes.
Extends
Extended by
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
animationFrame? | readonly | ColumnRef | Column of frame values: one frame per value (in categoryOrders / first-appearance order), with a Play / Pause update menu and a slider. Axis ranges are fixed across frames. | AnimationFrameOptions.animationFrame |
animationGroup? | readonly | ColumnRef | Column matching rows across frames (ids), so each object moves rather than being replaced. | AnimationFrameOptions.animationGroup |
categoryOrders? | readonly | Readonly<Record<string, readonly unknown[]>> | Value orders per column: { day: ['Thu', 'Fri', 'Sat', 'Sun'] }. They order the traces and legend (for grouping columns), facets, frames and category axes. Values not listed follow in order of first appearance; listed values without rows still take a color and a facet (as px). | CommonOptions.categoryOrders |
color? | readonly | ColumnRef | Column to color by. | DiscreteColorOptions.color |
colorDiscreteMap? | readonly | Readonly<Record<string, string>> | "identity" | Fixed colors per value of color ({ Asia: 'red' }); other values continue with the sequence. 'identity': the values are colors themselves (no legend entries for them). | DiscreteColorOptions.colorDiscreteMap |
colorDiscreteSequence? | readonly | readonly string[] | Colors for the values of color, in order. Default: the template's colorway. | DiscreteColorOptions.colorDiscreteSequence |
customData? | readonly | readonly ColumnRef[] | Columns put in customdata (first, before hoverData's), e.g. for click handlers. | HoverOptions.customData |
direction? | readonly | "clockwise" | "counterclockwise" | Angular axis direction. Default 'clockwise' (px). | - |
height? | readonly | number | Figure height in px (layout.height). | CommonOptions.height |
hoverData? | readonly | | readonly ColumnRef[] | Readonly<Record<string, string | boolean>> | More columns for the hover label, through customdata: a list of columns, or an object that adds columns (true), removes lines (false, e.g. { x: false }) or formats them (':.2f', `' | %Y'`). |
hoverName? | readonly | ColumnRef | Column shown in bold at the top of the hover label (hovertext). | HoverOptions.hoverName |
labels? | readonly | Readonly<Record<string, string>> | Display names of columns: { gdpPercap: 'GDP per capita' }. Used for axis titles, hover lines, the legend title, facet labels, the colorbar title and the animation slider. | CommonOptions.labels |
logR? | readonly | boolean | Log radial axis. | - |
r? | readonly | ColumnRef | Column of radii. | - |
rangeR? | readonly | readonly [number, number] | Fixed radial range, in data units (a log axis takes data units too, as px). | - |
rangeTheta? | readonly | readonly [number, number] | Angular sector drawn, [start, end] in degrees (polar.sector). | - |
startAngle? | readonly | number | Where the angular axis starts, in degrees counterclockwise from east. Default 90 (the top). | - |
template? | readonly | string | Template | layout.template: a registered name ('plotly-classic') or a template object. Default: unset, so the chart's default template applies (Holochart's holochart look); its colorway, symbol and dash cycles and sequential colorscale are what the figure's colors are taken from. | CommonOptions.template |
theta? | readonly | ColumnRef | Column of angles (degrees) or angular categories ('N', 'NNE', …). | - |
title? | readonly | string | Figure title (layout.title.text). | CommonOptions.title |
width? | readonly | number | Figure width in px (layout.width). | CommonOptions.width |