IChartPolarBarWedge

interface
Chart

Single wedge descriptor produced by the polar-bar geometry engine. Exposes the pre-computed SVG <path d="…"> for the arc, label anchor position, and all data needed to render accessibility text and tooltip content.

TypeScript

Definition

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

typescript

API

Properties

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

index
required
number
Wedge index in the original data array.
d
required
string
SVG <path d="…"> for the annular wedge shape.
color
required
string
Resolved CSS colour string (intended for :style="{ fill: … }").
category
required
string
Category label.
value
required
number
Raw numeric value.
formatted
required
string
Pre-formatted value string (via yAxisFormat or String(value)).
visible
required
boolean
Whether this wedge is currently visible (legend toggle).
outerR
required
number
Computed outer radius for this wedge.
innerR
required
number
Fixed inner radius (shared across all wedges).
startAngle
required
number
Start angle (radians).
endAngle
required
number
End angle (radians).
midAngle
required
number
Midpoint angle used for label placement.
labelX
required
number
X coordinate of the category label anchor.
labelY
required
number
Y coordinate of the category label anchor.
labelAnchor
required
'start' | 'middle' | 'end'
SVG text-anchor for the category label.
percentage
required
string
Percentage of total as a formatted string (e.g. "23.4%").
showValueLabel
required
boolean
Whether the wedge is wide enough to host a value label inside.
valueLabelX
required
number
X coordinate of the in-wedge value label.
valueLabelY
required
number
Y coordinate of 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.

Consuming wedge descriptors from the polar-bar engine

typescript