IChartPyramidProps

interface
Chart

Props for <OrigamChartPyramid> — the pyramid / funnel family. A single series of N data points is rendered as N horizontal trapezoids stacked vertically. type="funnel" = widest at top (conversion funnel); type="pyramid" = widest at bottom. 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.

type
TChartPyramidKind
Rendering mode. "funnel" = widest at top; "pyramid" = widest at bottom. Default "funnel".
sliceGap
number
Gap between consecutive trapezoid slices, in SVG pixels. Default 4.
labelPlacement
'inside' | 'outside' | 'auto'
Label placement strategy. "inside" — always inside; "outside" — always beside; "auto" — inside when slice height >= 28px, outside otherwise. Default "auto".
xAxisFormat
(value: string | number) => string
X-axis / value formatter applied to the per-slice value label. When omitted the raw number is displayed.
yAxisFormat
(value: number) => string
Y-axis formatter — alias kept for API symmetry with other families. Same as xAxisFormat for this geometry.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Conversion funnel chart

vue