IChartPolarProps

interface
Chart

Props for <OrigamChartPolar> — handles pie and donut visualisations. No axes, no grid, no tick labels. Extends IChartBaseProps with polar-specific options including donut hole size, drilldown configuration, and axis formatters.

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.

type
TChartPolarKind
Polar visualisation primitive. Default "pie".
donutHoleSize
number
Inner-radius proportion for "donut". 0 collapses to a pie, 1 to a zero-thickness ring. Ignored when type="pie". Default 0.6.
showTooltip
boolean
Toggle the hover tooltip. Default true.
xAxisFormat
(value: string | number) => string
Formatter applied to the tooltip X label. Pie tooltips show the category name + value.
yAxisFormat
(value: number) => string
Formatter applied to the tooltip Y value.
drilldown
IChartDrilldownProps
Drilldown configuration. When provided, data points that carry an IChartDrilldownLink trigger a chart-level navigation. A breadcrumb <nav> appears above the chart when depth > 1.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Donut chart with drilldown

vue