Interface: BarPolarOptions
Options of barPolar: px.bar_polar's arguments in camelCase.
Extends
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. | PolarOptions.animationFrame |
animationGroup? | readonly | ColumnRef | Column matching rows across frames (ids), so each object moves rather than being replaced. | PolarOptions.animationGroup |
barmode? | readonly | "relative" | "overlay" | "stack" | 'relative' (px's default) and 'stack' stack the groups' bars at each angle; 'overlay' draws them over each other (layout.polar.barmode). | - |
base? | readonly | ColumnRef | Column of bar bases (the radius each bar starts at). | - |
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). | PolarOptions.categoryOrders |
color? | readonly | ColumnRef | Column to color by. | PolarOptions.color |
colorContinuousMidpoint? | readonly | number | cmid: the value at the middle of a diverging colorscale. | ContinuousColorOptions.colorContinuousMidpoint |
colorContinuousScale? | readonly | ContinuousScale | Colorscale of a numeric color. Default: the template's sequential colorscale. | ContinuousColorOptions.colorContinuousScale |
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). | PolarOptions.colorDiscreteMap |
colorDiscreteSequence? | readonly | readonly string[] | Colors for the values of color, in order. Default: the template's colorway. | PolarOptions.colorDiscreteSequence |
customData? | readonly | readonly ColumnRef[] | Columns put in customdata (first, before hoverData's), e.g. for click handlers. | PolarOptions.customData |
direction? | readonly | "clockwise" | "counterclockwise" | Angular axis direction. Default 'clockwise' (px). | PolarOptions.direction |
height? | readonly | number | Figure height in px (layout.height). | PolarOptions.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). | PolarOptions.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. | PolarOptions.labels |
logR? | readonly | boolean | Log radial axis. | PolarOptions.logR |
pattern? | readonly | ColumnRef | Column whose values get different fill patterns. | PatternOptions.pattern |
patternShapeMap? | readonly | Readonly<Record<string, string>> | "identity" | Fixed shapes per value; 'identity': the values are shapes. | PatternOptions.patternShapeMap |
patternShapeSequence? | readonly | readonly string[] | Shapes in order. Default: '', /, \, x, +, .. | PatternOptions.patternShapeSequence |
r? | readonly | ColumnRef | Column of radii. | PolarOptions.r |
rangeColor? | readonly | readonly [number, number] | [cmin, cmax] of the colorscale. | ContinuousColorOptions.rangeColor |
rangeR? | readonly | readonly [number, number] | Fixed radial range, in data units (a log axis takes data units too, as px). | PolarOptions.rangeR |
rangeTheta? | readonly | readonly [number, number] | Angular sector drawn, [start, end] in degrees (polar.sector). | PolarOptions.rangeTheta |
startAngle? | readonly | number | Where the angular axis starts, in degrees counterclockwise from east. Default 90 (the top). | PolarOptions.startAngle |
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. | PolarOptions.template |
theta? | readonly | ColumnRef | Column of angles (degrees) or angular categories ('N', 'NNE', …). | PolarOptions.theta |
title? | readonly | string | Figure title (layout.title.text). | PolarOptions.title |
width? | readonly | number | Figure width in px (layout.width). | PolarOptions.width |