Alluvial

Creates an alluvial (parallel sets) chart from plain data rows: one column per entry in dimensions, one node per category in each column, and bands between neighboring columns sized by how many rows (or how much value) flow between each pair of categories. Each band keeps the color of its rows’ category in the colorBy column across every column.

Basic example

Each entry in dimensions is a column, and each category in it a node. With no value, every row counts once, so a band’s width is the number of orders that share its two categories. Bands keep their region’s color all the way across, so each region’s orders can be followed from left to right.

nodeSort

How the nodes in each column are ordered, top to bottom: "crossings" (the default: the first column by value, then each column by where its flows come from, which untangles the bands), "value" (largest first), "data" (the order categories first appear in the data), or a comparator receiving two nodes ({category, column, label, value}).

crossingsvaluedata

Summed values

When each row is already a count, value sums it. A {value, title} dimension names its column; here the Titanic’s 2,201 passengers and crew flow from class to survival.

value

Each row's weight: a data key or an accessor (d, i) => number. Node and band sizes sum it, so a key sums that field. Defaults to counting rows.

Color by

colorBy picks the column whose categories color the bands (a key, a title, or a column index). Coloring by survival shows, in every column, how many survived. nodeSort: "data" keeps the categories in the order they appear in the data.

colorBy

The column whose categories color the bands: a column index, or a dimension's data key or title. Each row's band keeps its category's color through every column, and the legend lists that column's categories. Defaults to the first column.

"survived"

nodeSort

crossingsvaluedata

Accessor dimension

A dimension can be computed with an accessor. nodeSort: "value" orders every column largest first, in place of the default "crossings", which orders each column after the first by where its flows come from to untangle the bands.

nodeSort

crossingsvaluedata

Configuration

import {Alluvial} from "@d3plus/core";

Extends Viz.

Filter 33 config keys

activefalse | function

The active callback function for highlighting shapes.

bandOpacitynumberDefault 0.5

The fill opacity of the bands between columns.

classNamestring | array.<string> | undefined

CSS classes added to the outermost element this chart or component draws into, next to its fixed d3plus classes, so page CSS can target it: a chart's root <svg class="d3plus-viz"> (its <canvas> with the Canvas renderer) and a standalone component's <svg>. Takes a space-separated string or an array. A new value replaces the classes the previous one added; unset adds none. Tooltips take their own tooltipConfig.className.

colorBynumber | stringDefault 0

colorDefaultscolordefaultsconfig

Overrides the default colors used when assigning fills from data and choosing legible text colors: dark and light (the text colors picked for contrast against a background), missing (null/undefined values), on/off (true/false values), sequential (the anchor hue for magnitude ramps), and scale (the categorical palette, given as a d3 ordinal scale or an array of colors). Keys are merged into the current defaults, and a Viz passes its overrides down to the shapes and components it draws.

configd3plusconfig

Methods that correspond to the key/value pairs and returns this class.

datastring | array.<datapoint> | object

The primary data array used to draw the visualization. The value passed should be an Array of objects or a String representing a filepath or URL to be loaded. The following filetypes are supported: csv, tsv, txt, and json.

If your data URL needs specific headers to be set, an Object with a "url" and "headers" (or any other fetch request option) may also be passed. An Object with any other key is a data row, not a request.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full config object from the data formatter (including the new data array as a key in the object).

To re-fetch a URL on an interval and redraw when its data changes, set dataPollingInterval; each poll runs the same formatter.

Defaults to an empty array ([]).

dimensionTitleConfigobjectDefault {}

Styles the column titles above each column (any TextBox config).

dimensions(string | function | {value: string | function, title?: string})[]Default []

The categorical dimensions, one column each, left to right: data keys, accessor functions (d, i) => category, or {value, title} objects (value being a key or an accessor). A key is its column's title; a bare accessor has none. Rows missing a category on any dimension (undefined, null, or "") are left out; to keep them, map the missing values to a category of their own with an accessor.

Splits the chart into small multiples: a grid of equally sized panels, one per distinct value of this data key or accessor, each drawing the chart for that value's rows. The panels share one legend, color scale, title, and timeline, color each series the same way, and hover, tooltips, and legend clicks apply across all of them. Pass false to draw a single chart. See facetConfig for the grid's layout and shared scales.

facetConfigfacetconfig

Configuration for small multiples (see facet), merged into the current config: - columns / rows: the grid's shape. Chosen by default to make the panels as large as the chart's shape allows. - padding: the space between panels, in pixels (default 20). - sort: panel order — "ascending" (default), "descending", "data" (first appearance), a comparator over facet values, or an Array of values. - scales: "shared" (default) gives every panel of a chart with axes the same x/y domains; "independent" fits each panel to its own rows. Funnel defaults to "independent" (each panel sized to its own widest stage); "shared" sizes every panel against the widest stage across all panels. PolarArea and RadialBar default to "independent" (each panel's rings and ticks fit its own values); "shared" gives every panel the same value domain. - axes: with shared scales, "outer" (default) labels the axes only along the grid's left and bottom edges; "all" labels every panel. An object sets each axis on its own, as in {x: "all", y: "outer"}: every panel labels its x axis, only the left column labels its y axis, and the panels' plot areas line up. BumpChart defaults to "all", and Marimekko labels its categories on every panel and its 0–100% share axis only along the outer edge, even with independent scales. - title: a (value, data) => string function for each panel's title, or false to hide panel titles. - titleConfig: TextBox config for the panel titles (fontSize, fontWeight, fontColor, textAnchor, padding, …).

fontFamilystring | array.<string>

The font family used throughout the visualization.

groupBystring | function | array.<string | function>

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

highlightfalse | function

Persistently emphasizes the data points matching the given predicate: the matching marks keep their color while every other mark is de-emphasized to a neutral gray (the "emphasis" form — highlight one series, gray the rest). Unlike hover/active (transient, opacity-based), highlight is a standing state that survives pointer movement. Pass false to clear it.

hoverfalse | function

The hover callback function for highlighting shapes on mouseover.

localestring | object

The locale used for all text and number formatting. Supports the locales defined in d3plus-format. The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

nodePaddingunknownDefault 10

The vertical gap between nodes in the same column, in pixels.

nodeSort"crossings" | "value" | "data" | functionDefault "crossings"

nodeWidthunknownDefault 16

The width of each node, in pixels.

onstring

Event listener for the specified event typenames. Mirrors the core d3-selection behavior.

parentunknown

Parent config used by the wrapper.

renderfunction

Draws the visualization given the specified configuration.

rendererboolean | "svg" | "canvas"

Selects which @d3plus/render backend paints the visible output. "svg" = SvgRenderer (default), "canvas" = CanvasRenderer. Boolean arguments both normalize to "svg".

selectstring | htmlelement

The SVG container element as a d3 selector or DOM element. Defaults to undefined.

shapeConfigd3plusconfig

Configuration object with key/value pairs applied as method calls on each shape.

thresholdnumber | function

The threshold value for bucketing small data points together, as a share of the total. On a stacked Plot, the series whose summed value across every position is under that share of the whole chart's total merge into one series, stacked on top. A bucket needs at least two items, and its tooltips list them. Off (0) by default on Plot charts.

thresholdKeystring | function

Accessor for the value used in the threshold algorithm. A stacked Plot defaults to its stacked value.

timestring | false | function

Accessor function or string key for the time dimension of each data point.

timelineDefaultstring | date | array.<string | date>

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

tooltipConfigtooltipconfigDefault

{title: (d: DataPoint, i: number) => alluvialTooltipTitle(viz, d, i), tbody: (d: DataPoint) => alluvialTooltipRows(viz, d)}

Configuration for the tooltip component.

totalstring | boolean | function

Accessor function or string key for the total value displayed in the visualization.

translatefunction

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

valuestring | functionDefault countRows

Each row's weight: a data key or an accessor (d, i) => number. Node and band sizes sum it, so a key sums that field. Defaults to counting rows.