Ribbon Chart API

Watch a composition re-rank itself over time, one connected category at a time. See the Ribbon Chart demo.

Import

Web Component

import "@michi-vz/wc/ribbon-chart";
// <michi-vz-ribbon-chart> is now defined

Vanilla JS

import { mountRibbonChart } from "@michi-vz/core";

const chart = mountRibbonChart(el, props);

Props

Prop	Type	Default	Description
series*	RibbonDataRow[]	—	Array of rows (one per date) whose keys stack into a column; same-key segments are linked across adjacent dates by ribbon trapezoids
keys*	string[]	—	Ordered segment keys to stack within each column (bottom-to-top) and to connect with ribbons between columns
title	string	—	Optional chart title rendered above the plot
xAxisFormat	(d: number | string) => string	—	Formats an x tick value into its display label
yAxisFormat	(d: number | string) => string	—	Formats a y tick value into its display label
yAxisDomain	[number, number]	—	Explicit [min, max] for the value (y) axis; overrides the auto domain from the stacked column totals
columnWidth	number	30	column width in px (default 30).
ticks	number	5	Approximate number of axis ticks to generate
tooltipFormatter	(row: RibbonDataRow, key: string, value: number) => string	—	Returns custom tooltip HTML for a hovered datum (sanitized before it is inserted)
onHighlightItem	(labels: string[]) => void	—	Called when the hovered/highlighted label(s) change

Common props — shared by every chart (14)

Prop	Type	Default	Description
width	number	900	Chart width in pixels
height	number	480	Chart height in pixels
margin	Margin	{ top: 50, right: 50, bottom: 60, left: 60 }	Inner margins (top/right/bottom/left, in px) reserved for axes, titles, and labels
colors	string[]	—	Categorical palette for series/labels without an explicit colour or colorsMapping entry
colorsMapping	Record<string, string>	—	Explicit label -> colour map; takes precedence over the palette and per-item colours
highlightItems	string[]	—	Labels to emphasise; all other marks dim
disabledItems	string[]	—	Labels to hide and exclude from scales/stacks
renderer	"svg" | "canvas"	"svg"	Render as inline SVG (default) or to a canvas (faster for large datasets); getContext() is identical either way
locale	string	—	BCP-47 locale used for number and date formatting
skipColorMappingDispatch	boolean	false	External-CSS mode: unmapped labels resolve to transparent and onColorMappingGenerated is not emitted, so mark colours come from your CSS via the data-label-safe contract
enableTransitions	boolean	true	Animate updates with CSS transitions (default true)
onColorMappingGenerated	(mapping: Record<string, string>) => void	—	Called with the resolved label -> colour map after the chart assigns colours
onChartDataProcessed	(context: ChartContext) => void	—	Called with the renderer-agnostic ChartContext whenever the data is (re)processed
onDataWarning	(warnings: DataWarning[]) => void	—	Called with any non-fatal data warnings (duplicate labels, non-finite values, gaps, ...)

Events

The web component dispatches these bubbling CustomEvents (the engine exposes the same via the on* callbacks in the table above):

Event	Detail	Fires when
michi-vz:highlight	string[]	hover highlight changes
michi-vz:colormapping	Record<string, string>	a color mapping is generated
michi-vz:dataprocessed	ChartContext	data is (re)processed
michi-vz:datawarning	DataWarning[]	input warnings are detected

getContext()

mountRibbonChart(el, props).getContext() returns a renderer-agnostic RibbonChartContext (structured stats + a deterministic natural-language summary + an a11y table). See LLM context.

Source

Props are typed as RibbonChartProps in @michi-vz/core.