Skip to content

Network

Creates a network visualization based on a defined set of nodes and edges.

Each node supplies its own x/y coordinates, so d3plus places nodes exactly rather than solving a layout for them.

const config = {
  groupBy: "id",
  nodes: [
    {id: "alpha", x: 1, y: 1},
    {id: "beta", x: 2, y: 1},
    {id: "gamma", x: 1, y: 2},
    {id: "epsilon", x: 3, y: 2},
    {id: "zeta", x: 2.5, y: 1.5},
    {id: "theta", x: 2, y: 2},
  ],
  links: [
    {source: 0, target: 1},
    {source: 0, target: 2},
    {source: 3, target: 4},
    {source: 3, target: 5},
    {source: 5, target: 0},
  ],
};

Omitting x/y from the nodes lets a force simulation position them automatically—reach for this when connections matter but there’s no meaningful spatial layout.

const config = {
  nodes: [
    {id: "alpha"},
    {id: "beta"},
    {id: "gamma"},
    {id: "epsilon"},
    {id: "zeta"},
    {id: "theta"},
  ],
  links: [
    {source: 0, target: 1, weight: 10},
    {source: 0, target: 2, weight: 10},
    {source: 3, target: 4, weight: 10},
    {source: 3, target: 5, weight: 5},
    {source: 5, target: 0, weight: 20},
    {source: 2, target: 1, weight: 12},
    {source: 4, target: 5, weight: 12},
  ],
  linkSize: d => d.weight,
};

A network with no colors of its own is colored by the clusters in it: groups of nodes linked more to each other than to the rest, found with the Louvain method and weighted by linkSize, so here the heaviest collaborations pull hardest. Each cluster is named after its most-connected node (“Fay cluster”). The legend lists the clusters largest first, even though this network has only nodes and no data, and clicking one zooms to it. At most clusterConfig.max clusters are kept (12 by default, so each gets its own palette color): while there are more, the smallest joins the cluster it shares the most link weight with, or the largest cluster when it has no links to another. Each name is also written inside its cluster, where it fits clear of the nodes and their labels, shrinking down to clusterConfig.labelConfig.fontMin (10px) before it is left off; the legend still names every cluster.

Clusters apply only while the chart’s color is its default. Setting color, colorScale, colorOrdinal, or a shapeConfig fill colors the nodes as configured instead, and so does more than one groupBy level. A network with fewer than two clusters of two or more nodes (no links, or one cluster holding everything) keeps one color per node, as does a node with no links. Set cluster to false to turn clustering off. linkColor: "source" colors each link like its source node’s cluster, and charts linked with link share the clusters’ colors when they share their names.

Network and ArcDiagram: colors each node by the cluster it belongs to, found with the Louvain method (links weighted by linkSize). Each cluster is named after its most-connected node ("alpha cluster"), and the legend lists the clusters, largest first, even for a network drawn from nodes alone; clicking a cluster zooms to it. A Network also writes each name inside its cluster, where it fits clear of the nodes and their labels. Applies only while the chart's color is its default: setting color, colorScale, colorOrdinal, or a shapeConfig fill, or more than one groupBy level, colors nodes as configured instead. A network with fewer than two clusters of two or more nodes keeps one color per node. A node with no links keeps its own color and label. false turns clustering off. Defaults to true.

linkSize

The thickness of each link: a pixel number used for every link, or an accessor function whose values are scaled between linkSizeMin and linkSizeMax (see linkSizeScale). The function receives each link, with source and target set to the data of the nodes at its ends, and its index in links.

ƒ (function)

clusterConfig.label names each cluster: it receives the row of the cluster’s most-connected node, the cluster’s index (0 is the largest), and every member’s row. clusterConfig.labelConfig styles the names written on the chart (fontMax, fontMin, padding, and TextBox settings such as fontColor or fontWeight), or false leaves them to the legend.

const people = "Ada Ben Cleo Dev Eli Fay Gus Hana Ivo Jun Kai Lea Mo Nia Omar"
  .split(" ")
  .map(id => ({id}));

const pairs = [
  ["Ada", "Ben", 6],
  ["Ada", "Cleo", 4],
  ["Ben", "Cleo", 5],
  ["Ada", "Dev", 3],
  ["Cleo", "Dev", 2],
  ["Dev", "Eli", 4],
  ["Ben", "Eli", 2],
  ["Fay", "Gus", 7],
  ["Fay", "Hana", 5],
  ["Gus", "Hana", 3],
  ["Gus", "Ivo", 4],
  ["Hana", "Ivo", 2],
  ["Ivo", "Jun", 5],
  ["Fay", "Jun", 2],
  ["Kai", "Lea", 6],
  ["Kai", "Mo", 4],
  ["Lea", "Mo", 3],
  ["Mo", "Nia", 5],
  ["Lea", "Nia", 2],
  ["Nia", "Omar", 4],
  ["Kai", "Omar", 3],
  ["Eli", "Fay", 1],
  ["Jun", "Kai", 1],
  ["Omar", "Ada", 1],
];

const config = {
  nodes: people,
  links: pairs.map(([source, target, papers]) => ({source, target, papers})),
  linkSize: d => d.papers,
  clusterConfig: {
    label: (d, i, members) => `${d.id}'s lab (${members.length})`,
    labelConfig: {fontMax: 20, fontWeight: 400},
  },
};

linkSize takes an accessor returning each link’s weight, which d3plus runs through a square-root scale (linkSizeScale) to set stroke thickness—heavier links render thicker. The thinnest link is linkSizeMin pixels wide (1 by default) and the widest linkSizeMax, which defaults to half the smallest node’s radius so that even the heaviest links stay narrower than the nodes they join.

linkSize

The thickness of each link: a pixel number used for every link, or an accessor function whose values are scaled between linkSizeMin and linkSizeMax (see linkSizeScale). The function receives each link, with source and target set to the data of the nodes at its ends, and its index in links.

ƒ (function)

The thinnest link, in pixels, when linkSize values differ.

Network, Rings, and Geomap: the widest link, in pixels, when linkSize values differ. Network and Rings default to half the smallest node's radius (never thinner than linkSizeMin); Geomap defaults to 10. A linkSizeMin wider than a set linkSizeMax is held to it.

arrows draws an arrowhead at the node boundary to show edge direction. Use "target", "source", "both", or a per-link accessor for bi-directional edges. arrowSize overrides the automatic size.

Draws arrowheads on the links: true (or "target") at each link's target end, "source" at its source end, "both", or false for none. Also accepts an accessor function returning one of those per link.

The arrowhead size in pixels, or an accessor function returning one per link. Defaults to three times the link's stroke width, at least 6 and at most 12 pixels, but never under 1.5 times the stroke width so the head stays wider than its line. The line stops inside the head.

Sizing nodes with size adds a size legend. When there’s room it is drawn in the open space around the nodes (see legendInset), otherwise in the bottom-right corner. It is drawn with the chart’s own radius scale, which Network fits to the space between nodes. Zoom in and the circles keep their size while the labels change to the values those circles now represent on screen.

Sizes each node: a data key or an accessor function whose values are scaled between sizeMin and sizeMax (see sizeScale). When unset, every node is drawn at the same size.

The minimum pixel radius used when sizing nodes.

The maximum pixel radius used when sizing nodes. Defaults to half the distance between the two closest nodes.

Whether to display the size legend: a nested-circle key, in the chart's bottom-right corner, for charts that size their marks with a size accessor (bubble plots, Geomap points via pointSize, Network, Rings). By default it shows whenever marks are sized by more than one value, unless it would take up more than a third of the chart's width or height. Pass true to always show it, false to hide it, or a function that receives the resolved chart config, the radius scale, and the legend's measured {width, height, availableWidth, availableHeight}, and returns a boolean.

A network gathered in the middle of a wide chart leaves its corners empty, so the legend is drawn in one of them, over a translucent box, instead of taking a margin. Zoom in and the nodes slide under the box while the legend stays readable. Set legendInset to false to keep the legend in its margin.

Whether the chart may draw one of its legends inside the empty space around its marks instead of in a margin, for charts that leave open space around their marks, such as Plot and the charts built on it, Network, Pack, Pie, and Geomap; a chart whose marks fill its area, like Treemap, keeps its legends in the margins. After the chart lays out, the size legend is tried first, then the legend, then the colorScale; the first that fits is drawn over a semi-transparent box (see legendInsetConfig), and any others keep their margins. Space enclosed by the marks, like the middle of a ring of points, is never used. Only a legend or colorScale whose position is "auto" (the default) can move inside; one set to a side stays in that margin. Defaults to true; also accepts a function that receives the resolved chart config and returns a boolean.

A node’s label stays inside it when it fits there at a readable size (pointLabelConfig.fontMin, 10px by default). Otherwise it moves beside the node, on the side with the most open room, as long as it overlaps no other node or label; a label with no room is hidden, and the node’s tooltip still names it. Bigger nodes are labeled first. Set labelPosition to "inside" to keep every label inside its node, shrinking it to fit, or "outside" to put every label beside its node.

Where each shape's label goes, as a string for every shape or a (d, i) => string accessor of the data row.

- Ring segments (Donut slices and those of a Pie with an innerRadius, Sunburst arcs, Chord groups, and RadialBar tracks): "along" runs a segment's name along its arc, following the ring, reading left to right on the bottom half as on the top. "auto" picks, segment by segment, whichever reads better: the curve when its arc is long enough for the whole name and it shows it larger than a straight label could (a thin ring), the straight label when that fits as well, and a curve cut short with an ellipsis when nothing else fits. A full Pie (no innerRadius) keeps its labels inside straight: its wedges run to a point at the center. On a Pie or Donut (any innerRadius, and partial rings such as a half pie), a slice whose label inside can't show its whole name under "auto" is labelled outside the ring instead, and "outside" labels every slice there: its name and share, horizontal, in the Path labelConfig's font at its fontSize (12px by default), in the theme's text color unless labelConfig.fontColor sets one, joined to the slice by a thin leader line. These labels stack in a column on the side of the ring their slice faces, wrapping onto a second line between words when their column is narrow; the ring shrinks (its hole with it) to leave room for them, never below 60% of its full radius, and when they don't all fit, the smallest slices' labels are left out (those slices keep their label inside, if any). "inside" keeps a Pie or Donut's labels straight inside their slices, and on the other ring segments both "inside" and "outside" keep the straight labels. A Donut's curves follow the middle of its ring (the rim, when its hole is small), with the slice's share on a smaller second line when there is room. A Sunburst also weighs a label turned along its radius, which suits the narrow arcs of the outer rings. Curved Donut and Sunburst names keep 5px from the ring's edges and at least 0.3em from the segment's ends, at the largest size from the Path labelConfig's fontSize (else fontMax, 24px by default) down to its fontMin (8px). A Chord curves its group names just outside the ring when every name fits along its arc, which leaves the ring more room; otherwise it curves those that fit and turns the rest along their spokes, all at the Path labelConfig's fontSize (11px by default). A Radar does the same with its metric names, just outside the web, each between its neighbors' spokes, wrapping a long name onto a second curved line. A RadialBar curves each track's name along the track, inside its bar (or past its end when the bar is too short), when the sweep leaves no room before the start for the straight labels, and at any sweep for "along"; when every track is named this way, the default legend hides. Curved text takes the color that contrasts with what lies under it (the theme's ink outside the ring) and dims with its segment on hover. A label with no room is left out. - Bars: "inside" or "outside" the bar, or "auto", which goes outside when the bar is shorter than half the room along its axis. Stacked bars always label inside. - Circles (scatter and bubble points, Beeswarm points given a label, Network nodes, and Geomap coordinate points): "auto" keeps a label inside its circle when it fits there at pointLabelConfig.fontMin or larger, else moves it beside the circle, else hides it. A Network or Geomap's labels beside their circles stay in the chart area, a Plot's in its plot area. "inside" keeps every label inside, shrinking it to fit (a label that can't fit is dropped). "outside" always puts it beside the circle. A label goes beside its circle on the side with the most open room: the side facing its Voronoi cell's centroid first, then right, left, top, bottom, and the diagonals. A side is taken only where the label lies mostly in the circle's Voronoi cell, stays in that area, and overlaps no circle and no label placed before it. Larger circles are placed first. A label with no room is hidden; the circle's tooltip and aria-label still name it. Geomap points are labeled by shapeConfig.Circle.label when it is set (false turns their labels off), else by label. Labels are placed when the chart draws: a zoomed Plot places them again for its new scales, while a zoomed Network or Geomap scales them with the picture. - Stacked areas (StackedArea, Streamgraph, and a stacked AreaPlot): "auto" or "along" runs each series' name along its band's centerline, following its curve, on the stretch where the band is at least the font size plus 4px thick under the whole label and flattest. The text reads upright, in the color that contrasts with the band's fill (or the Area labelConfig's fontColor, when you set one), and dims with its band on hover. It starts at the Area labelConfig's fontSize (or fontMax, else 16px) and shrinks a pixel at a time down to its fontMin, but no lower than 8px, before giving up; a band too thin for its name everywhere goes unlabeled. When every band gets a name, the default legend hides (a legend of your own always wins, and the legend stays while a series is hidden from it). "inside" (or "outside") puts the label in the band's largest box instead. shapeConfig.Area.label sets the text, or false for none.

Defaults to "auto".

Hovering a link highlights it and the two nodes it connects, and its tooltip names them (“alpha → beta”) above the link’s own fields. Hovering a node lists its number of connections and, when linkSize gives the links different values, its strongest links with their values; nodeTooltipLinks sets how many (false for none). linkSize, link shapeConfig functions, and tooltip accessors all receive each link with source and target set to the data of its nodes, so here a link between two nodes in the same group draws darker. Click a link to focus and zoom to it and its nodes; click it again, or the background, to reset.

linkColor colors each link. A key or accessor whose values are numbers colors the links on the chart’s colorScale, which then shows the links’ values beside the legend for the nodes’ colors. Strings are used as colors when they parse as one, or else as categories in the chart’s palette, the way color colors nodes. "source" or "target" colors each link like one of its nodes. Arrowheads take their link’s color. When the chart also sets colorScale for its nodes, nodes and links share that one scale. Because links are thin lines, a light theme’s ramp starts at a mid-tone rather than a near-white tint, so the lowest values still show (colorScaleConfig.ordinalRamp).

linkColor

Colors each link: "source" or "target" takes that end node's color, and a key or accessor function reads a value from each link (receiving the link and its index in links). A number is colored on the chart's colorScale, which then shows the links' values; a string is a color when it parses as one, or else a category in the chart's palette. false (the default) draws every link in the theme's link gray.

"trips"

linkLabel writes a key or accessor’s value at the middle of each link, between the nodes it joins, on a pad of the chart’s background so it reads over the line. linkLabelConfig.rotate runs the text along each link ("along", the default, kept upright) or keeps it level ("horizontal"), and takes font settings such as fontSize and fontColor. On a curved link, a self-loop or a bundled edge (see Edge bundling), the text follows the curve over a pad that bends with it, cut short with an ellipsis where the curve has too little room. linkLabelConfig.minRadius sets the tightest bend a label follows, as a radius in ems (2 by default): a loop bending tighter keeps a straight label, which reads better than a few letters crowded around the turn. A label that would cover a node, a node’s label, or another link’s label is hidden, the thickest links’ labels kept first.

Text drawn at the middle of each link: a key or accessor function (receiving the link and its index in links). Numbers are abbreviated in the chart's locale. Labels that would cover a node or another label are hidden. Defaults to none.

A link whose source and target are the same node draws as a loop outside the node, pointing into the widest gap between the node’s other links (or away from the middle of the network when it has none). Its thickness comes from linkSize, its label from linkLabel (at the loop’s far point), and arrows draws its arrowhead where it comes back into the node. Several loops on one node fan out side by side, the heaviest in the middle. A loop has the same tooltip, hover, click focus, and keyboard focus as any other link, and a node’s tooltip lists it as “↻ node”.

linkSize

The thickness of each link: a pixel number used for every link, or an accessor function whose values are scaled between linkSizeMin and linkSizeMax (see linkSizeScale). The function receives each link, with source and target set to the data of the nodes at its ends, and its index in links.

ƒ (function)
linkLabel

Text drawn at the middle of each link: a key or accessor function (receiving the link and its index in links). Numbers are abbreviated in the chart's locale. Labels that would cover a node or another label are hidden. Defaults to none.

ƒ (function)

Draws arrowheads on the links: true (or "target") at each link's target end, "source" at its source end, "both", or false for none. Also accepts an accessor function returning one of those per link.

linkBundle pulls links that run the same way near each other into shared curves that fan out at their ends, so the main flows between groups read through the clutter of a dense network. Two links bundle when they are close to parallel, of similar length, near each other, and alongside each other (force-directed edge bundling, after Holten and van Wijk). linkBundleConfig.strength sets how closely each link keeps to its bundle, from 0 (straight) to 1; compatibility sets how alike two links must be to bundle (lower bundles more); and cycles, iterations, and smoothing tune the simulation and the curve. Arrowheads, labels, tooltips, and click focus follow each curve, and a link from a node to itself keeps its loop. The bundling is worked out once per layout and reused while the chart zooms, pans, or is hovered.

Bundles the links: links running the same way near each other are drawn pulled together, so the main flows read through the clutter. Defaults to false.

Draws arrowheads on the links: true (or "target") at each link's target end, "source" at its source end, "both", or false for none. Also accepts an accessor function returning one of those per link.

Configuration

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

Extends Viz.

activefalse | function

The active callback function for highlighting shapes.

aggsobject

Custom aggregation functions keyed by data property.

ariaHiddenbooleanDefault true

Hides the SVG from assistive technology when true (aria-hidden).

arrowSizenumber | function

The arrowhead size in pixels, or an accessor function returning one per link. Defaults to three times the link's stroke width, at least 6 and at most 12 pixels, but never under 1.5 times the stroke width so the head stays wider than its line. The line stops inside the head.

arrowsboolean | "target" | "source" | "both" | functionDefault false

Draws arrowheads on the links: true (or "target") at each link's target end, "source" at its source end, "both", or false for none. Also accepts an accessor function returning one of those per link.

attributionstring | booleanDefault false

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

attributionIconstring | function

Overrides the "ⓘ" icon a long attribution collapses to (see attribution), which otherwise renders as an inline SVG. Accepts an HTML string — used as the toggle button's content — or a mount function, (el: HTMLElement) => void | (() => void), called once with the button's reserved icon slot so a live component (a React tree via createRoot(el).render(...), or anything else imperative) can be mounted into it. A returned cleanup function runs right before that slot is discarded, which happens whenever the credit's markup regenerates (its text or theme changes), not just once per chart.

attributionStylerecord

CSS key/value pairs used to style the attribution text.

backControlClassNamestring

An additional CSS class name (or space-separated list of class names) applied to the back button, alongside its fixed back-control class. Setting this automatically disables d3plus's built-in inline backControlStyle default (as long as you haven't already customized it yourself), so a host page's own button styling — Tailwind, Bootstrap, a design system — applies through the cascade with no other configuration needed.

backControlStylerecord | false

An object containing CSS key/value pairs that is used to style the back button. Passing false will remove all default styling. Automatically skipped (as if false) once .backControlClassName(...) is set, unless you've explicitly customized this yourself.

cachebooleanDefault true

Whether the chart keeps the files it fetches for data, links, nodes, topojson, and fitObject. Each chart has its own cache of its 10 most recent requests, keyed by the request (the URL, and a request object's fetch options), so loaders naming the same URL share one request. It holds each response as fetched, before its *Format formatter runs, so setting the same URL again, or a new formatter, draws from the cache without a request. A failed request is not kept. Defaults to true; set it to false to fetch on every load, or use dataPollingInterval to re-fetch data on a schedule (polls always fetch).

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.

clusterbooleanDefault true

Network and ArcDiagram: colors each node by the cluster it belongs to, found with the Louvain method (links weighted by linkSize). Each cluster is named after its most-connected node ("alpha cluster"), and the legend lists the clusters, largest first, even for a network drawn from nodes alone; clicking a cluster zooms to it. A Network also writes each name inside its cluster, where it fits clear of the nodes and their labels. Applies only while the chart's color is its default: setting color, colorScale, colorOrdinal, or a shapeConfig fill, or more than one groupBy level, colors nodes as configured instead. A network with fewer than two clusters of two or more nodes keeps one color per node. A node with no links keeps its own color and label. false turns clustering off. Defaults to true.

clusterConfigclusterconfigDefault {}

Network and ArcDiagram: names and styles the clusters (see cluster). label names each cluster: it receives the row of the cluster's most-connected node, the cluster's index (0 is the largest), and every member's row. max is the most clusters to keep (default 12): while there are more, the smallest joins the cluster it shares the most link weight with, or the largest when it has none. labelConfig styles the names a Network draws inside its clusters, or false draws none.

colorstring | false | function

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

When the color is a category that isn't one of the groupBy levels (for example, points grouped by "country" and colored by "region"), the legend shows one entry per category, labelled by the category. Clicking, shift+clicking, or hovering an entry hides, solos, or highlights every item in that category.

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.

colorOrdinalbooleanDefault false

Treat a discrete color field as ordered: color it with a single-hue light→dark ramp instead of nominal categorical hues.

colorScalestring | false | function

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

colorScaleConfigobject

A pass-through to the config method of ColorScale.

colorScaleMaxSizenumberDefault 600

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

colorScalePaddingboolean | function

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

colorScalePositionfalse | panelposition | function

Defines which side of the visualization to anchor the color scale. Acceptable values are "auto" (the default), "top", "bottom", "left", "right", and false. "auto" lets the chart choose: inside the chart when it fits there (see legendInset), otherwise the right side of charts more than 1.5 times as wide as they are tall and the bottom of all others. Any other side keeps the color scale there. A false value will cause the color scale to not be displayed, but will still color shapes based on the scale.

configd3plusconfig

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

datastring | array.&lt;datapoint&gt; | 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.

To transform the data before it is drawn (for example, a JSON API that returns its headers split from its values), set dataFormat. Passing a formatter as a second argument to this method sets dataFormat; calling it with only data keeps the current dataFormat.

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

Defaults to an empty array ([]).

dataCutoffnumberDefault 100

Maximum number of data points to render before downsampling.

dataFormatfunction

Transforms data before it is drawn. The function receives the loaded file (or the parsed JSON response, or an Array of them when data lists several URLs), or the Array passed as data, and returns the rows to draw. It may instead return a config object holding the rows as its data key, and the rest of that object is applied to the chart, so a response can set options such as title from what it contains.

It runs when the chart renders, whichever order data and dataFormat are set in, and setting it again re-runs it on the next render, over the cached response (see cache). Every dataPollingInterval poll runs it too. Passing a formatter as the second argument of data(url, format) sets it, and setting data alone keeps it.

dataPollingIntervalnumber | falseDefault false

When data is loaded from a URL (or a request object, or an Array holding one), re-fetches it every this many milliseconds and redraws with a transition when it changes, keeping hover, zoom, legend toggles, and the timeline selection. Each poll uses the same request and dataFormat as the first load, and a response identical to the drawn data is not redrawn. Polling waits while the browser tab is hidden or, with detectVisible, while the chart is scrolled out of view, and catches up as soon as it is visible again. A failed request keeps the last data, logs one warning per run of failures, and tries again on the next tick. destroy(), setting this to false, or passing new data stops polling. Only data is polled, not links, nodes, or topojson. Defaults to false (load once).

depthnumber

Active depth level for nested groupings.

detectResizebooleanDefault true

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to true, the Viz will listen for the window.onresize event and adjust it's dimensions accordingly.

detectResizeDelaynumberDefault 400

When resizing the browser window, this is the millisecond delay to trigger the resize event.

detectVisiblebooleanDefault true

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to true, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

detectVisibleIntervalnumberDefault 1000

The interval, in milliseconds, for checking if the visualization is visible on the page. When detectVisible defers a render until the visualization scrolls into view, this is also how long it must stay in view before it renders, so visualizations scrolled past quickly are never drawn.

detectVisibleUnloadbooleanDefault true

When true (the default) and detectVisible is enabled, the Viz releases its DOM and scene while it is scrolled out of view and redraws when it returns, keeping the page light when there are many visualizations. Data and configuration are retained; interaction state such as zoom or selection is not, so set this to false to keep it. With detectVisible enabled, each chart's <svg> is also given content-visibility: auto, so the browser skips rendering its contents while it is far off-screen (this matters most when this is false and charts are kept). For a larger saving you can also apply content-visibility: auto and a contain-intrinsic-size to the container element yourself; that adds paint containment to an element you own, so it is not done automatically. Requires IntersectionObserver.

discrete"x" | "y" | "radius" | "angle"

Sets orientation of main category axis.

durationnumberDefault 600

Default duration of transitions, in milliseconds.

facetstring | false | function

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, …).

filterfalse | function

Predicate filtering which data points are included, or false to disable.

fontFamilystring | array.&lt;string&gt;

The font family used throughout the visualization.

groupBystring | function | array.&lt;string | function&gt;

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.

heightnumber

Overall height of the visualization in pixels.

hiddenColorcsscolor | function

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

hiddenOpacitynumber | function

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

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.

hoverDistancenumberDefault 20

How close, in pixels, the pointer has to come to a point mark for it to count as hovering that point. Over empty space, or over something other than a point (a gridline, a link), the pointer acts on the closest point whose edge lies within this distance: its tooltip, hover highlight, and axis guides show, and a click there clicks it. A point's tooltip points at the top of the point (on it or near it) and holds still until another point takes over. Applies to the point marks of scatter and bubble plots (Circle and Rect shapes, Beeswarm included), Network nodes, and Geomap points; bars, areas, lines, and other area-filling marks keep exact hit-testing. Plots with a discrete axis and tooltipShared on snap to the nearest column instead. Defaults to 20; 0 turns it off, along with the anchored tooltip.

keyboardNavbooleanDefault true

Lets keyboard users move between the chart's data marks. The chart is one Tab stop (a focusable role="application" element laid over it, named by svgTitle or the chart's title); once it has focus, the arrow keys move to the nearest mark in that direction, Home and End jump to the first and last mark, Enter or Space selects the focused mark as a click would (drilling down, or toggling a legend item), and Escape clears it. The focused mark shows its tooltip and hover highlight, a ring outlines it (see keyboardNavConfig), and a live region announces its label to screen readers. Legend items are included after the chart's marks; Line and Area series are visited point by point. On by default; false removes the Tab stop.

keyboardNavConfigkeyboardnavconfig

Styles the focus ring around the mark keyboard navigation has focused (see KeyboardNavConfig).

labelstring | false | accessorfn | array.&lt;string&gt;

Accessor function, or a constant string applied to every data point's label (unlike value/nodeId/etc., a string here is not treated as a per-datum object key — pass a function for that).

labelPosition"auto" | "along" | "inside" | "outside" | function

Where each shape's label goes, as a string for every shape or a (d, i) => string accessor of the data row.

- Ring segments (Donut slices and those of a Pie with an innerRadius, Sunburst arcs, Chord groups, and RadialBar tracks): "along" runs a segment's name along its arc, following the ring, reading left to right on the bottom half as on the top. "auto" picks, segment by segment, whichever reads better: the curve when its arc is long enough for the whole name and it shows it larger than a straight label could (a thin ring), the straight label when that fits as well, and a curve cut short with an ellipsis when nothing else fits. A full Pie (no innerRadius) keeps its labels inside straight: its wedges run to a point at the center. On a Pie or Donut (any innerRadius, and partial rings such as a half pie), a slice whose label inside can't show its whole name under "auto" is labelled outside the ring instead, and "outside" labels every slice there: its name and share, horizontal, in the Path labelConfig's font at its fontSize (12px by default), in the theme's text color unless labelConfig.fontColor sets one, joined to the slice by a thin leader line. These labels stack in a column on the side of the ring their slice faces, wrapping onto a second line between words when their column is narrow; the ring shrinks (its hole with it) to leave room for them, never below 60% of its full radius, and when they don't all fit, the smallest slices' labels are left out (those slices keep their label inside, if any). "inside" keeps a Pie or Donut's labels straight inside their slices, and on the other ring segments both "inside" and "outside" keep the straight labels. A Donut's curves follow the middle of its ring (the rim, when its hole is small), with the slice's share on a smaller second line when there is room. A Sunburst also weighs a label turned along its radius, which suits the narrow arcs of the outer rings. Curved Donut and Sunburst names keep 5px from the ring's edges and at least 0.3em from the segment's ends, at the largest size from the Path labelConfig's fontSize (else fontMax, 24px by default) down to its fontMin (8px). A Chord curves its group names just outside the ring when every name fits along its arc, which leaves the ring more room; otherwise it curves those that fit and turns the rest along their spokes, all at the Path labelConfig's fontSize (11px by default). A Radar does the same with its metric names, just outside the web, each between its neighbors' spokes, wrapping a long name onto a second curved line. A RadialBar curves each track's name along the track, inside its bar (or past its end when the bar is too short), when the sweep leaves no room before the start for the straight labels, and at any sweep for "along"; when every track is named this way, the default legend hides. Curved text takes the color that contrasts with what lies under it (the theme's ink outside the ring) and dims with its segment on hover. A label with no room is left out. - Bars: "inside" or "outside" the bar, or "auto", which goes outside when the bar is shorter than half the room along its axis. Stacked bars always label inside. - Circles (scatter and bubble points, Beeswarm points given a label, Network nodes, and Geomap coordinate points): "auto" keeps a label inside its circle when it fits there at pointLabelConfig.fontMin or larger, else moves it beside the circle, else hides it. A Network or Geomap's labels beside their circles stay in the chart area, a Plot's in its plot area. "inside" keeps every label inside, shrinking it to fit (a label that can't fit is dropped). "outside" always puts it beside the circle. A label goes beside its circle on the side with the most open room: the side facing its Voronoi cell's centroid first, then right, left, top, bottom, and the diagonals. A side is taken only where the label lies mostly in the circle's Voronoi cell, stays in that area, and overlaps no circle and no label placed before it. Larger circles are placed first. A label with no room is hidden; the circle's tooltip and aria-label still name it. Geomap points are labeled by shapeConfig.Circle.label when it is set (false turns their labels off), else by label. Labels are placed when the chart draws: a zoomed Plot places them again for its new scales, while a zoomed Network or Geomap scales them with the picture. - Stacked areas (StackedArea, Streamgraph, and a stacked AreaPlot): "auto" or "along" runs each series' name along its band's centerline, following its curve, on the stretch where the band is at least the font size plus 4px thick under the whole label and flattest. The text reads upright, in the color that contrasts with the band's fill (or the Area labelConfig's fontColor, when you set one), and dims with its band on hover. It starts at the Area labelConfig's fontSize (or fontMax, else 16px) and shrinks a pixel at a time down to its fontMin, but no lower than 8px, before giving up; a band too thin for its name everywhere goes unlabeled. When every band gets a name, the default legend hides (a legend of your own always wins, and the legend stays while a series is hidden from it). "inside" (or "outside") puts the label in the band's largest box instead. shapeConfig.Area.label sets the text, or false for none.

Defaults to "auto".

legendboolean | function

Whether to display the legend. By default, the legend shows when it has more than one entry and each entry stands for a single group (or two groups at most), or when the entries are colored by a category that isn't a groupBy level (see color), in which case each entry is labelled by its category. Pass false to hide it, true to always show it, or a (config, data) => boolean function to decide.

legendConfigobject

Configuration object passed to the legend's config method.

legendFilterInvertboolean | function

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking will solo that category and shift+clicking will hide that category. The Back button undoes each click (see legendHistory).

legendHistorybooleanDefault true

Whether legend clicks go on the chart's Back history. A click or shift+click (or Enter or Space on a legend item) that changes what is hidden or solo'd shows the Back button, and Back undoes legend clicks and drill-downs in the order they happened, restoring the legend exactly as it was. A drill-down to a deeper level starts with every group shown, and Back out of it brings back the legend it left. A click that changes nothing adds no step, and new data clears the legend's steps along with the legend. Clicking a Sunburst or Icicle center zooms out without undoing the legend clicks made since the zoom. Defaults to true; false leaves legend clicks off the history, so Back only steps out of drill-downs.

legendInsetboolean | functionDefault true

Whether the chart may draw one of its legends inside the empty space around its marks instead of in a margin, for charts that leave open space around their marks, such as Plot and the charts built on it, Network, Pack, Pie, and Geomap; a chart whose marks fill its area, like Treemap, keeps its legends in the margins. After the chart lays out, the size legend is tried first, then the legend, then the colorScale; the first that fits is drawn over a semi-transparent box (see legendInsetConfig), and any others keep their margins. Space enclosed by the marks, like the middle of a ring of points, is never used. Only a legend or colorScale whose position is "auto" (the default) can move inside; one set to a side stays in that margin. Defaults to true; also accepts a function that receives the resolved chart config and returns a boolean.

legendInsetConfigobject

Style of the box drawn behind a legend placed inside the chart (see legendInset): fill (defaults to the chart's background color), fillOpacity (0.85), stroke (defaults to a faint contrasting line), strokeWidth (1), rx (corner radius, 4), margin (space between the box's edge and the legend, 6), and padding (space kept between the box and the chart's marks and edges, 10).

legendPaddingboolean | function

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

legendPositionfalse | panelposition | function

Defines which side of the visualization to anchor the legend. Expected values are "auto" (the default), "top", "bottom", "left", "right", and false to hide it. "auto" lets the chart choose: inside the chart when it fits there (see legendInset), otherwise the right side of charts more than 1.5 times as wide as they are tall and the bottom of all others. Any other side keeps the legend there.

legendSortfunction

Comparator that orders the legend's entries. By default the legend reads in the order the chart draws: Treemap, Pack, Pie, Donut, Icicle, and Sunburst list their largest entries first; a stacked chart lists its series in stacking order, from the baseline outward (so the default stackOrder, "descending", lists the largest first); Waffle and Waterfall follow their own order, and Network and ArcDiagram clusters come largest first; every other chart is alphabetical by label. A threshold group always comes last, whatever the sort.

legendTooltiptooltipconfig

Configuration object for the legend tooltip.

Links this chart to every other chart with the same group name, so hovering, active, highlight (including search), and legend hide/solo clicks in one are mirrored in the rest, and a value gets the same categorical color in every chart. Rows match across charts by the value of by (a data key or accessor), which defaults to the chart's own id. A string is shorthand for {group}; set hover, active, highlight, legend, or color to false to stop sharing that behavior.

linkBundlebooleanDefault false

Bundles the links: links running the same way near each other are drawn pulled together, so the main flows read through the clutter. Defaults to false.

linkBundleConfiglinkbundleconfigDefault {strength: 0.85, cycles: 6, iterations: 50, compatibility: 0.4, smoothing: true}

Tunes linkBundle: strength (0.85), cycles (6), iterations (50), compatibility (0.4), and smoothing (true).

linkColorfalse | "source" | "target" | string | functionDefault false

Colors each link: "source" or "target" takes that end node's color, and a key or accessor function reads a value from each link (receiving the link and its index in links). A number is colored on the chart's colorScale, which then shows the links' values; a string is a color when it parses as one, or else a category in the chart's palette. false (the default) draws every link in the theme's link gray.

linkLabelstring | function

Text drawn at the middle of each link: a key or accessor function (receiving the link and its index in links). Numbers are abbreviated in the chart's locale. Labels that would cover a node or another label are hidden. Defaults to none.

linkLabelConfiglinklabelconfig

Styles the link labels: rotate, "along" (the default) to run text along its link, kept upright, or "horizontal"; fontSize (10); padding, the pad around the text (2); backgroundOpacity, the opacity of that pad in the chart's background color (0.85); minRadius, the tightest bend a curved label follows, as a radius in ems (2); and any other TextBox setting, such as fontColor, fontFamily, or fontWeight.

linkSizenumber | functionDefault 1

The thickness of each link: a pixel number used for every link, or an accessor function whose values are scaled between linkSizeMin and linkSizeMax (see linkSizeScale). The function receives each link, with source and target set to the data of the nodes at its ends, and its index in links.

linkSizeMaxnumber

Network, Rings, and Geomap: the widest link, in pixels, when linkSize values differ. Network and Rings default to half the smallest node's radius (never thinner than linkSizeMin); Geomap defaults to 10. A linkSizeMin wider than a set linkSizeMax is held to it.

linkSizeMinnumberDefault 1

The thinnest link, in pixels, when linkSize values differ.

linkSizeScalestringDefault sqrt

The type of continuous d3-scale used to size links (e.g. "linear", "sqrt", "log").

The edges that connect the nodes. The source and target of each link refer to a node in one of three ways: its index in the nodes array, the node object itself (matched by its id), or a string matching the node's id. A link whose source and target are the same node draws as a loop beside it.

Accepts an array of links, or a URL/filepath string to load them from. linksFormat transforms them; a function passed as a second argument sets it.

linksFormatfunction

Network, Rings, Sankey, Chord, ArcDiagram, and Geomap: transforms links before they are drawn. The function receives the loaded file (or the Array passed as links) and returns the links Array. It runs when the chart renders, whichever order links and linksFormat are set in, and setting it again re-runs it on the next render. Passing a formatter as the second argument of links(url, format) sets it, and setting links alone keeps it.

loadingHTMLstring | function

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

loadingMessagebooleanDefault true

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

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.

messageMaskstring | booleanDefault rgba(0, 0, 0, 0.05)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to false to turn off the mask completely.

messageStylerecord

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

minimapbooleanDefault true

Shows a small overview + draggable-viewport minimap underneath the zoom controls once the chart is zoomed in. On by default whenever zoom is enabled.

minimapClassNamestring

An additional CSS class name (or space-separated list of class names) applied to the minimap's outer box, viewport box, and zoom-level label, alongside their fixed d3plus-minimap / d3plus-minimap-viewport / d3plus-minimap-label classes. Setting this automatically disables d3plus's built-in inline minimapStyle/minimapViewportStyle/minimapViewportStyleActive/minimapLabelStyle defaults (as long as you haven't already customized them yourself), so a host page's own styling applies through the cascade with no other configuration needed.

minimapLabelStylerecord | false

An object containing CSS key/value pairs that is used to style the minimap's zoom-level text label (e.g. "2x"). Passing false will remove all default styling. Automatically skipped (as if false) once .minimapClassName(...) is set, unless you've explicitly customized this yourself.

minimapStylerecord | false

An object containing CSS key/value pairs that is used to style the minimap's outer box (the full-scene overview). Passing false will remove all default styling. Automatically skipped (as if false) once .minimapClassName(...) is set, unless you've explicitly customized this yourself.

minimapViewportStylerecord | false

An object containing CSS key/value pairs that is used to style the minimap's draggable viewport box in its resting state. Passing false will remove all default styling. Automatically skipped (as if false) once .minimapClassName(...) is set, unless you've explicitly customized this yourself.

minimapViewportStyleActiverecord | false

An object containing CSS key/value pairs that is used to style the minimap's draggable viewport box while it's being dragged. Passing false will remove all default styling. Automatically skipped (as if false) once .minimapClassName(...) is set, unless you've explicitly customized this yourself.

noDataHTMLstring | function

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

noDataMessagebooleanDefault false

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

nodeGroupBystring | function | (string | function)[]Default [null]

The key(s) or accessor(s) that identify each object passed to nodes, one per groupBy depth, used in place of groupBy for nodes that the data doesn't cover. Defaults to each node's id.

How many links a node's tooltip lists under its number of connections, strongest first: a number, or false for none. Defaults to 3 when the links differ in linkSize, and none otherwise.

nodesobject[] | stringDefault []

The nodes to draw. Accepts an array of node objects, or a URL/filepath string to load them from. nodesFormat transforms them; a function passed as a second argument sets it.

nodesFormatfunction

Network, Rings, Sankey, Chord, and ArcDiagram: transforms nodes before they are drawn. The function receives the loaded file (or the Array passed as nodes) and returns the nodes Array. It runs when the chart renders, whichever order nodes and nodesFormat are set in, and setting it again re-runs it on the next render. Passing a formatter as the second argument of nodes(url, format) sets it, and setting nodes alone keeps it.

onstring

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

parentunknown

Parent config used by the wrapper.

pointLabelConfigpointlabelconfig

Fits and styles circle labels (see labelPosition): fontMin is the smallest font size a label may shrink to inside its circle before "auto" moves it beside the circle (default 10, the size of the chart's smallest text, its total); fontSize is the size of a label beside its circle (default 11); padding is the space between the circle's edge and that label (default 3). The other TextBox keys (fontColor, fontFamily, fontWeight, fontOpacity, …) style the labels beside their circles, which default to the chart's text color. Merged into the current config.

reducedMotion"auto" | booleanDefault auto

Whether the chart animates. "auto" (default) follows the viewer's OS setting, read from the (prefers-reduced-motion: reduce) media query at each draw (server-side rendering counts as not reduced). true always draws without motion: shapes, axes, legends, zooms, and fades jump straight to their final state. false always animates. duration keeps the value you set either way.

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".

saveControlbooleanDefault true

Shows a top-left download button that saves the chart, as the reader sees it, as a PNG, SVG, or JPG file. On by default for every chart.

saveControlClassNamestring

An additional CSS class name (or space-separated list of class names) applied to the download button, alongside the fixed save-control/save-toggle classes. Setting this automatically disables d3plus's built-in inline saveControlStyle/saveControlStyleActive/saveControlStyleHover defaults (as long as you haven't already customized them yourself), so a host page's own button styling applies through the cascade with no other configuration needed.

saveControlConfigsavecontrolconfig

Options for the download button: the saved file's filename, the formats it offers, the background painted behind the chart, a callback, and html-to-image options for PNG and JPG files.

saveControlMenuClassNamestring

An additional CSS class name (or space-separated list of class names) applied to the download menu, alongside its fixed d3plus-save-menu class (each item has the fixed save-menu-item class). Setting this automatically disables d3plus's built-in inline saveControlMenuStyle/saveControlMenuItemStyle/saveControlMenuItemStyleHover defaults (as long as you haven't already customized them yourself), so a host page's own menu styling applies through the cascade. The menu's position and open/closed display stay inline.

saveControlMenuItemStylerecord | false

An object containing CSS key/value pairs that is used to style each item in the download menu. Passing false will remove all default styling. Automatically skipped (as if false) once .saveControlMenuClassName(...) is set, unless you've explicitly customized this yourself.

saveControlMenuItemStyleHoverrecord | false

An object containing CSS key/value pairs that is used to style the download menu item under the pointer or keyboard focus. Passing false will remove all default styling. Automatically skipped (as if false) once .saveControlMenuClassName(...) is set, unless you've explicitly customized this yourself.

saveControlMenuStylerecord | false

An object containing CSS key/value pairs that is used to style the download menu: its background, border, shadow, and spacing. Passing false will remove all default styling. Automatically skipped (as if false) once .saveControlMenuClassName(...) is set, unless you've explicitly customized this yourself.

saveControlStylerecord | false

An object containing CSS key/value pairs that is used to style the download button. Passing false will remove all default styling. Automatically skipped (as if false) once .saveControlClassName(...) is set, unless you've explicitly customized this yourself.

saveControlStyleActiverecord | false

An object containing CSS key/value pairs that is used to style the download button while its menu is open. Passing false will remove all default styling. Automatically skipped (as if false) once .saveControlClassName(...) is set, unless you've explicitly customized this yourself.

saveControlStyleHoverrecord | falseDefault false

An object containing CSS key/value pairs that is used to style the download button on hover. Passing false will remove all default styling. Automatically skipped (as if false) once .saveControlClassName(...) is set, unless you've explicitly customized this yourself.

scrollContainerstring | htmlelement | window

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

Shows a top-left search button that expands into an input; typing highlights shapes whose label matches. On by default for every chart.

searchAccessorfunction

Resolves the string the search box matches its typed term against, for a given datum. Defaults to the mark's resolved on-screen label (viz._drawLabel) — the same text the user reads on the chart. Override it to match against something else instead, e.g. a data field that isn't shown as the label.

This is checked alongside, not instead of, every level of the datum's own groupBy hierarchy — searching a leaf's label also matches its ancestor group's cell/legend entry, and vice versa, regardless of this accessor's override.

searchControlClassNamestring

An additional CSS class name (or space-separated list of class names) applied to the search toggle button and input, alongside their fixed search-control classes. Setting this automatically disables d3plus's built-in inline searchControlStyle/searchControlStyleActive/searchControlStyleHover defaults (as long as you haven't already customized them yourself), so a host page's own button styling — Tailwind, Bootstrap, a design system — applies through the cascade with no other configuration needed.

searchControlStylerecord | false

An object containing CSS key/value pairs that is used to style the search toggle button. Passing false will remove all default styling. Automatically skipped (as if false) once .searchControlClassName(...) is set, unless you've explicitly customized this yourself.

searchControlStyleActiverecord | false

An object containing CSS key/value pairs that is used to style the search toggle button while open. Passing false will remove all default styling. Automatically skipped (as if false) once .searchControlClassName(...) is set, unless you've explicitly customized this yourself.

searchControlStyleHoverrecord | falseDefault false

An object containing CSS key/value pairs that is used to style the search toggle button on hover. Passing false will remove all default styling. Automatically skipped (as if false) once .searchControlClassName(...) is set, unless you've explicitly customized this yourself.

selectstring | htmlelement

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

shapestring | functionDefault "Circle"

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

shapeConfigd3plusconfig

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

sizestring | function

Sizes each node: a data key or an accessor function whose values are scaled between sizeMin and sizeMax (see sizeScale). When unset, every node is drawn at the same size.

sizeLegendboolean | function

Whether to display the size legend: a nested-circle key, in the chart's bottom-right corner, for charts that size their marks with a size accessor (bubble plots, Geomap points via pointSize, Network, Rings). By default it shows whenever marks are sized by more than one value, unless it would take up more than a third of the chart's width or height. Pass true to always show it, false to hide it, or a function that receives the resolved chart config, the radius scale, and the legend's measured {width, height, availableWidth, availableHeight}, and returns a boolean.

sizeLegendConfigsizelegendconfig

Configuration object passed to the size legend's config method: values (an array of values to draw, or how many to pick), tickFormat, title (defaults to the size key when size is set to a string), shapeConfig, lineConfig, labelConfig, titleConfig, padding, lineLength, and labelPadding.

sizeLegendPosition"right" | "bottom"Default right

Which margin the size legend claims in the chart's bottom-right corner. "right" (the default) widens the right margin, so the chart keeps its full height and the legend sits at the bottom of the right column, below any right-side legend or colorScale. "bottom" deepens the bottom margin instead, so the chart keeps its full width and any bottom legend or colorScale narrows to sit beside it.

sizeMaxnumber

The maximum pixel radius used when sizing nodes. Defaults to half the distance between the two closest nodes.

sizeMinnumberDefault 5

The minimum pixel radius used when sizing nodes.

sizeScalestringDefault sqrt

The type of continuous d3-scale used to size nodes (e.g. "linear", "sqrt", "log").

subtitlestring | function

Accessor function or string for the visualization's subtitle.

subtitleConfigrecord

Configuration object for the subtitle.

subtitlePaddingboolean | function

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

svgDescstring

Accessible description applied to the root SVG (<desc>).

svgTitlestring

Accessible title applied to the root SVG (<title>).

tableViewbooleanDefault true

Enables the top-left table-view toggle button, which swaps the chart for a static, scrollable <table> of its data. On by default for every chart.

tableViewClassNamestring

An additional CSS class name (or space-separated list of class names) applied to the <table> element the table-view toggle renders, alongside the fixed d3plus-table-view-table class. Lets a host page style the data table with its own table styling (Tailwind, Bootstrap, a design system) via descendant selectors.

tableViewControlClassNamestring

An additional CSS class name (or space-separated list of class names) applied to the table-view toggle button, alongside the fixed table-view-control/table-view-toggle classes. Setting this automatically disables d3plus's built-in inline tableViewControlStyle/tableViewControlStyleActive/tableViewControlStyleHover defaults (as long as you haven't already customized them yourself), so a host page's own button styling applies through the cascade with no other configuration needed.

tableViewControlStylerecord | false

An object containing CSS key/value pairs that is used to style the table-view toggle button. Passing false will remove all default styling. Automatically skipped (as if false) once .tableViewControlClassName(...) is set, unless you've explicitly customized this yourself.

tableViewControlStyleActiverecord | false

An object containing CSS key/value pairs that is used to style the table-view toggle button while it is active (showing the data table). Passing false will remove all default styling. Automatically skipped (as if false) once .tableViewControlClassName(...) is set, unless you've explicitly customized this yourself.

tableViewControlStyleHoverrecord | falseDefault false

An object containing CSS key/value pairs that is used to style the table-view toggle button on hover. Passing false will remove all default styling. Automatically skipped (as if false) once .tableViewControlClassName(...) is set, unless you've explicitly customized this yourself.

tableViewDownloadbooleanDefault true

Whether the data table shows a "download CSV" button, exporting its full (sorted, unpaginated) rows. On by default.

tableViewPageSizenumber | falseDefault 50

The number of data-table rows shown per page while in table view. Set to false (or any non-positive number) to disable pagination and show every row on one page.

tableViewSortbooleanDefault true

Whether the data table's column headers are clickable to sort (toggling asc/desc). On by default.

themethemesettingDefault auto

The chart's colors. "auto" (the default) paints no background and follows the page behind the chart: its chrome text contrasts with the page, its tooltip, table view, and overlays turn dark on a dark page, and it redraws when the page flips between light and dark. "light" and "dark" paint the theme's background behind the chart (so it reads the same on any page, and in a saved image) and take every chrome color from the theme. An object sets your own tokens on top of the preset its base names ("light" or "dark"), for example {base: "dark", background: "#123", accent: "#ffd43b"}. A dark theme also turns color scale ramps around, from a dim tint near the background up to a bright pole (see the colorScale tokens). Colors you set in the other config (titleConfig.fontColor, tooltipConfig, colorScaleConfig.colorMax, the *Style options, …) win over the theme.

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.

thresholdNamestring | function

Label for the threshold group, or a (datum, index) accessor.

timestring | false | function

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

timeFilterfalse | function

Predicate filtering which time slices are shown, or false to disable. With time set and no timeFilter, a chart starts on its latest period, or on timelineDefault/timelineConfig.selection; setting it starts the chart (and its timeline) on the periods it keeps. A viewer's pick on the timeline replaces it.

timelinebooleanDefault true

Whether to show the timeline component.

timelineConfigtimelineconfig

Configuration object for the timeline.

timelineDefaultstring | date | array.&lt;string | date&gt;

The starting time or range for the timeline, which the chart starts on too. Can be a single Date/String, or an Array of 2 values representing the min and max. A viewer's pick on the timeline replaces it.

timelinePaddingboolean | function

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

titlestring | function

Accessor function or string for the visualization's title.

titleConfigrecord

CSS style configuration for the title.

titlePaddingboolean | function

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

tooltipboolean | function

Whether to show tooltips, or a (datum, index) accessor deciding per mark.

tooltipConfigtooltipconfigDefault linkTooltipConfig(viz)

Configuration for the tooltip component.

totalstring | boolean | function

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

totalConfigrecord

Configuration object for the total bar.

totalFormatfunction

Formatter function for the value in the total bar.

totalPaddingboolean | function

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

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.

widthnumber

Overall width of the visualization in pixels.

xstring | functionDefault function

The x position of each node: a key in the data or nodes, or an accessor function. Defaults to "x". When any node has no x/y position, every node is placed by a force simulation instead.

ystring | functionDefault function

The y position of each node: a key in the data or nodes, or an accessor function. Defaults to "y". When any node has no x/y position, every node is placed by a force simulation instead.

zoombooleanDefault true

Enables pan/zoom with zoom-control buttons. On by default for every chart.

zoomBrushHandleSizenumberDefault 1

The pixel stroke-width of the zoom brush area.

zoomBrushHandleStylerecord | false

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing false will remove all default styling.

zoomBrushSelectionStylerecord | false

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing false will remove all default styling.

zoomControlClassNamestring

An additional CSS class name (or space-separated list of class names) applied to each zoom control button, alongside the fixed zoom-control / zoom-in / zoom-out / zoom-reset / zoom-brush classes. Setting this automatically disables d3plus's built-in inline zoomControlStyle/zoomControlStyleActive/zoomControlStyleHover defaults (as long as you haven't already customized them yourself), so a host page's own button styling — Tailwind, Bootstrap, a design system — applies through the cascade with no other configuration needed.

zoomControlIconspartial

Overrides one or more of the four built-in zoom-control icons (zoomIn, zoomOut, zoomReset, zoomBrush), which otherwise render as inline SVGs. Each value is either an HTML string — used as the button's content in place of the built-in icon — or a mount function, (el: HTMLElement) => void | (() => void), called once with the button's reserved icon slot (a 12x12px element) so you can mount anything imperative into it: a React tree (createRoot(el).render(<Icon/>)), a Vue app, a canvas sprite, a brand <img>. Return a cleanup function from the mount function if there's teardown to do; it runs right before that slot is discarded — which happens whenever the whole button panel's markup regenerates (a .locale(...) change, a zoomControlClassName change, or the brush toggle switching), not just once per chart.

zoomControlStylerecord | false

An object containing CSS key/value pairs that is used to style each zoom control button (.zoom-in, .zoom-out, .zoom-reset, and .zoom-brush). Passing false will remove all default styling. Automatically skipped (as if false) once .zoomControlClassName(...) is set, unless you've explicitly customized this yourself.

zoomControlStyleActiverecord | false

An object containing CSS key/value pairs that is used to style each zoom control button when active (.zoom-in, .zoom-out, .zoom-reset, and .zoom-brush). Passing false will remove all default styling. Automatically skipped (as if false) once .zoomControlClassName(...) is set, unless you've explicitly customized this yourself.

zoomControlStyleHoverrecord | falseDefault false

An object containing CSS key/value pairs that is used to style each zoom control button on hover (.zoom-in, .zoom-out, .zoom-reset, and .zoom-brush). Passing false will remove all default styling. Automatically skipped (as if false) once .zoomControlClassName(...) is set, unless you've explicitly customized this yourself.

zoomFactornumberDefault 2

Multiplier applied to programmatic zoom steps.

zoomMaxnumber

Maximum zoom scale factor. Defaults to the scale at which the smallest shape fills the chart area.

zoomPaddingnumberDefault 20

A pixel value to be used to pad all sides of a zoomed area.

zoomPanbooleanDefault true

Whether panning (drag) is enabled while zoomed.

zoomScrollboolean | "modifier"Default modifier

Whether the mouse wheel (and one-finger touch) zooms. "modifier" (the default) leaves page scrolling alone: only Ctrl/⌘ + wheel or a trackpad/two-finger pinch zooms, and one finger pans only once zoomed in. true zooms on any wheel; false never does.