IChartPolarBarProps

interface
Chart

Props for <OrigamChartPolarBar> — the polar bar (nightingale-rose) family. A single series of N data points is rendered as N wedge-shaped arcs arranged radially. Commonly used for cyclical data (hours per day, monthly activity). Extends IChartBaseProps.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

innerRadius
number
Fraction of the total radius reserved as a centre hole. 0 = no hole (wedges meet at centre). 1 = zero-thickness ring. Default 0.1.
startAngle
number
Start angle in radians for the first wedge. 0 = 3 o'clock; -Math.PI/2 = 12 o'clock (conventional). Default 0.
gap
number
Angular gap between consecutive wedges in radians. 0 = no gap (flush). Default 0.02.
maxValue
number
Override the auto-computed maximum value used to scale wedge radii. When omitted, max(series[0].data) is used.
showLabel
boolean
Render the category label outside the outer radius of each wedge. Default true.
showValue
boolean
Render the numeric value label inside the wedge when there is sufficient angular room. Default false.
xAxisFormat
(value: string | number) => string
Formatter applied to the tooltip X label (category name / index).
yAxisFormat
(value: number) => string
Formatter applied to the tooltip Y value and the in-wedge value label.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Nightingale-rose chart for weekly activity

vue