IChartPictorialProps

interface
Chart

Props for <OrigamChartPictorial> — the pictorial / isotype family. Each data value is represented as a column of repeated SVG icons; filled icons count = Math.round(value / iconsPerUnit). Extends IChartBaseProps with icon appearance, direction, and rendering mode.

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.

icon
string
SVG <path d="…"> string for the icon drawn in each slot. Must fit a viewBox="0 0 24 24" coordinate system. Default: person silhouette.
iconColor
TIntent | string
Colour applied to all filled icons. Accepts a TIntent name or any raw CSS colour string. When omitted, colours cycle through colorScheme by series index.
emptyIconColor
string
Colour painted on background icon slots that are not yet filled. Default "rgba(0,0,0,0.1)".
iconsPerUnit
number
How many data units one icon represents. E.g. iconsPerUnit=10 → a value of 65 renders 7 filled icons (rounded). Default 1.
direction
TDirection
Stacking direction — "vertical" stacks icons bottom-to-top, "horizontal" stacks them left-to-right. Default "vertical".
mode
TChartPictorialMode
Rendering mode — "stack" = classic isotype rows of small icons (default); "fill" = one large icon per category clip-masked to the fill ratio.
showLabel
boolean
Display the raw value label above (vertical) or to the right (horizontal) of each column. Default true.
showAxis
boolean
Display the X-axis category labels. Default true.
xAxisFormat
(value: string | number) => string
X-axis / category label formatter. Identity by default.
yAxisFormat
(value: number) => string
Y-axis / value formatter. String(value) by default.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Isotype chart with custom icon and fill mode

vue