Skip to content

Type Alias: BarpolarTrace ​

ts
type BarpolarTrace = Omit<CommonTraceAttributes, 'hoverinfo'> & object;

Bars in polar coordinates: annular sectors from base to base + r at angle theta, stacked or overlaid per polar.barmode (wind roses).

Type Declaration ​

NameTypeDescription
base?unknownWhere bars start, in radial axis units (default 0). In stack barmode, traces that set base are not stacked: they are drawn from their base, as in overlay mode.
dr?numberRadial step of the implicit r.
dtheta?numberAngular step of the implicit theta. Defaults to the subplot period (a full turn, or the category count) divided by the number of points.
hoverinfo?PerPoint< | "r" | "theta" | "text" | "name" | `${"r" | "theta" | "text" | "name"}+${string}` | "all" | "none" | "skip">Which fields hover labels show (r: …, θ: …, the text and the trace name); 'skip' also turns hover events off for this trace. Default 'all'.
marker?BarpolarTraceMarkerBar style.
offset?PerPointNumberAngular shift of the leading edge of each bar from its theta (in thetaunit; category slots on category axes). Default: centered.
r?DataColumnRadial coordinates.
r0?unknownAlternative to r: the first radial coordinate, stepped by dr.
selected?BarTraceSelectedStyle of selected bars while a selection is active.
subplot?"polar" | `polar${number}`The polar subplot this trace is drawn on: 'polar' (layout.polar), 'polar2' (layout.polar2), ….
text?PerPoint<string | number>Hover text of each bar (one string for all, or one per bar).
theta?DataColumnAngular coordinates: numbers in thetaunit on a linear angular axis, category names on a category axis.
theta0?unknownAlternative to theta: the first angular coordinate, stepped by dtheta.
thetaunit?"radians" | "degrees" | "gradians"Unit of theta (and theta0, dtheta) on linear angular axes.
type"barpolar"Trace type.
unselected?BarTraceUnselectedStyle of unselected bars while a selection is active.
width?PerPointNumberAngular width of each bar (in thetaunit; category slots on category axes). Default: the smallest angle between bars, less polar.bargap. Minimum: 0

Released under the MIT License.