Fontein (Jet d'Eau) API

Eén grafiek, twee modi: tophoogte = waarde, opbloeiende pluim = onzekerheid. Categorische x = momentopname/vergelijking; temporele of numerieke x = trend - zie de Fontein-demo.

Import

Web Component

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

Vanilla JS

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

const chart = mountFountainChart(el, props);

Props

Prop	Type	Default	Description
timeline	boolean | TimelinePeriodConfig	-	Opt-in "play through years" (cumulative): the marks draw UP TO the active period and extend as the timeline steps; `interpolate` sweeps smoothly between years, `false` jump-cuts. Headless controller via `chart.timeline()` plus the built-in play button + scrubber. Off by default; wins over `progressiveDraw` when both are set.
progressiveDraw	boolean | ProgressiveDrawConfig	-	Opt-in reveal animation: wipes the marks in left to right on mount (a clip reveal; axes and titles stay put). `true` uses defaults (1200 ms, easeInOutCubic); a config tunes durationMs, easing, autoplay, and replayOnUpdate (`tipLabel` is LineChart-only and ignored here). Off by default; respects prefers-reduced-motion (renders fully drawn instantly) and `replay()` re-runs it.
dataSet*	FountainDataItem[]	-	Array of jets; each item renders one fountain
title	string	-	Optional chart title rendered above the plot
style	"jet" | "plume"	"jet"	Silhouette style: "jet" (default) is the faithful asymmetric Jet d'Eau (vertical column + wind-blown diagonal + a triangular droplet spray curtain); "plume" is the symmetric blooming column.
xAxisDataType	FountainXAxisType	-	How the x-axis is parsed: a temporal/numeric type renders TREND mode; "band" (or omitted) renders SNAPSHOT mode
yAxisDomain	[number, number]	-	Explicit [min, max] for the value (y) axis; overrides the auto domain from value + spread
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
ticks	number	5	Approximate number of axis ticks to generate
tickValues	Array<number | Date>	-	Explicit tick values, overriding the generated ones (trend mode)
frothLayers	number	14	Number of graduated-opacity froth layers per jet (default 14, max 20); a per-item density overrides it
bloomExponent	number	5	Exponent in the bloom easing w(h)=stemHalf+spread*(h/H)^p; larger = tighter column, sharper crown (default 5)
stemFraction	number	0.045	Stem half-width at the base as a fraction of the jet's slot width (default 0.045)
showDroplets	boolean	true	Draw ballistic droplet arcs above each apex (default true)
showMist	boolean	true	Draw the misty falling skirt around each nozzle (default true)
showTrendLine	boolean	true	Draw a connecting line through the apexes in trend mode (default true)
tooltipFormatter	(d: FountainDataItem) => string	-	Returns custom tooltip HTML for a hovered jet (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: 40, bottom: 50, 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" | "webgpu"	"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, non-monotonic dates, ...)

Twee modi, één datavorm

Stel xAxisDataType: "band" in (of laat het weg) voor de Momentopname-modus - elk item krijgt zijn eigen x-band, naast elkaar. Geef een temporele of numerieke xAxisDataType op plus een date bij elk item voor de Trend-modus - de jets worden langs de tijdas geplaatst en een trendlijn verbindt hun toppen. Een item met predicted: true wordt gestippeld weergegeven met een schuimigere kroon.

Gebeurtenissen

De webcomponent verzendt deze bubbelende CustomEvents (de engine biedt dezelfde functionaliteit via de on*-callbacks in de tabel hierboven):

Gebeurtenis	Detail	Treedt op wanneer
michi-vz:highlight	string[]	de highlight bij hover verandert (jet-label)
michi-vz:colormapping	Record<string, string>	er een kleurtoewijzing wordt gegenereerd
michi-vz:dataprocessed	ChartContext	gegevens worden (opnieuw) verwerkt
michi-vz:datawarning	DataWarning[]	invoerwaarschuwingen worden gedetecteerd (bijv. een niet-eindige waarde of spreiding)

getContext()

mountFountainChart(el, props).getContext() retourneert een renderer-onafhankelijke FountainChartContext:

• mode - "snapshot" voor een categorische/band-x, "trend" voor een temporele/numerieke x.
• jets - één item per zichtbare jet: { label, code?, color, value, spread, upperBound, spreadRatio, predicted, xPosition }. upperBound = value + spread; spreadRatio = spread / value (relatieve onzekerheid); xPosition is de ruwe datum/het ruwe getal in trend-modus, of null in momentopname-modus.
• stats - samenvattend object:
  • jetCount - aantal zichtbare jets.
  • tallest - { label, value } van de hoogste jet, of null indien leeg.
  • frothiest - { label, spreadRatio } van de meest onzekere jet, of null indien leeg.
  • trendSlope - helling van een lineaire regressie door de jet-waarden op index in trend-modus; null in momentopname-modus.
  • valueRange - [min, max] van de jet-waarden, of null indien leeg.
  • predictedCount - aantal voorspelde jets.

Zie LLM-context voor hoe je de context gebruikt in prompts en rapporten.

Bron

Props zijn getypeerd als FountainChartProps in @michi-vz/core.