Skip to content
D3plus

Waffle

Draws a grid of unit cells filled in order by category, each category getting cells in proportion to its value. By default the grid is 10 × 10, so each cell is 1% of the total; set unit to make each cell a fixed amount instead. Hover a cell to highlight its whole category.

Basic example

Section titled “Basic example”

Each of the 100 cells is 1% of the total, filled largest category first. Shares are rounded with the largest-remainder method, so the cells always add up to exactly 100. Hover a cell to highlight its whole category; the tooltip shows the category’s value and share.

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.

Accessor function or string key for each category's value. The categories get cells in proportion to it, allocated by the largest-remainder method so the cells always add up to the grid.

The number of rows in the grid. With unit and a column-wise fill, the grid keeps this many rows and adds columns as needed.

The number of columns in the grid. With unit, a row-wise fill keeps this many columns and adds rows as needed.

Cell shapes

Section titled “Cell shapes”

cellShape draws each cell as a "square", a "rounded" square, or a "circle", and cellPadding sets the gap between cells. sort: false fills in data order, keeping the answers on their scale.

cellShape

How each cell is drawn: "square", "rounded" (a square with rounded corners), or "circle".

The gap between neighboring cells, in pixels. It shrinks on small grids (such as small multiples) so the cells stay visible.

Fill direction

Section titled “Fill direction”

fillDirection: "column" fills each column before moving to the next, and fillStart picks the corner the first cell sits in. A 5 × 20 grid still holds 100 cells, so each is still 1%.

fillDirection

The order cells fill the grid: "row" fills along each row, "column" down each column.

The corner of the grid the first cell sits in.

The number of rows in the grid. With unit and a column-wise fill, the grid keeps this many rows and adds columns as needed.

The number of columns in the grid. With unit, a row-wise fill keeps this many columns and adds rows as needed.

Unit counts

Section titled “Unit counts”

unit: 500 makes each cell 500 attendees instead of a share of the total. The grid keeps its 12 columns and adds rows until every cell fits, so a larger total draws a taller waffle.

The value one cell stands for. By default the categories share every cell of the rows × columns grid, so each cell is a fixed share of the total (1% for 10 × 10); with a unit, each cell counts unit of the value and the grid grows to fit the total.

The number of columns in the grid. With unit, a row-wise fill keeps this many columns and adds rows as needed.

Pictogram

Section titled “Pictogram”

icon turns the waffle into a pictogram: every cell draws the image its accessor returns (here, person builds a silhouette SVG in each category’s color) in place of the fill. With unit: 1, each icon is one person.

icon

Draws an icon in every cell in place of its fill (a pictogram): an image URL, or an accessor (d, i) => url returning one per category. The icon fits inside its cell and dims with it on hover. A cell whose icon resolves to nothing (e.g. null) draws as in plain mode: its fill, shapeConfig.texture, and shapeConfig.backgroundImage.

ƒ (function)

The value one cell stands for. By default the categories share every cell of the rows × columns grid, so each cell is a fixed share of the total (1% for 10 × 10); with a unit, each cell counts unit of the value and the grid grows to fit the total.

Small multiples

Section titled “Small multiples”

facet draws one waffle per age group, side by side, with one shared legend. Each panel’s cells are that group’s own shares, so the panels compare at a glance.

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.

cellShape

How each cell is drawn: "square", "rounded" (a square with rounded corners), or "circle".

Configuration

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

Extends Viz.

activefalse | function

The active callback function for highlighting shapes.

cellPaddingnumberDefault 2

The gap between neighboring cells, in pixels. It shrinks on small grids (such as small multiples) so the cells stay visible.

cellShape"square" | "rounded" | "circle"Default "square"

How each cell is drawn: "square", "rounded" (a square with rounded corners), or "circle".

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.

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.

columnsnumberDefault 10

The number of columns in the grid. With unit, a row-wise fill keeps this many columns and adds rows as needed.

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.

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 ([]).

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

fillDirection"row" | "column"Default "row"

The order cells fill the grid: "row" fills along each row, "column" down each column.

fillStart"top-left" | "top-right" | "bottom-left" | "bottom-right"Default "top-left"

The corner of the grid the first cell sits in.

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.

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.

iconstring | function

Draws an icon in every cell in place of its fill (a pictogram): an image URL, or an accessor (d, i) => url returning one per category. The icon fits inside its cell and dims with it on hover. A cell whose icon resolves to nothing (e.g. null) draws as in plain mode: its fill, shapeConfig.texture, and shapeConfig.backgroundImage.

legendSortfunctionDefault fillOrder(viz)

Lists the legend in the order the categories fill the grid (see sort).

legendTooltiptooltipconfigDefault {tbody: waffleTooltipRows(viz)}

Configuration object for the legend tooltip.

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.

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

rowsnumberDefault 10

The number of rows in the grid. With unit and a column-wise fill, the grid keeps this many rows and adds columns as needed.

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.

sortfalse | functionDefault bySum(viz)

Comparator for the order categories fill the grid, given two rows. Defaults to descending by sum, with any threshold bucket last; false keeps the data order.

sumstring | functionDefault "value"

Accessor function or string key for each category's value. The categories get cells in proportion to it, allocated by the largest-remainder method so the cells always add up to the grid.

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.&lt;string | date&gt;

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 {tbody: waffleTooltipRows(viz)}

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.

unitnumber

The value one cell stands for. By default the categories share every cell of the rows × columns grid, so each cell is a fixed share of the total (1% for 10 × 10); with a unit, each cell counts unit of the value and the grid grows to fit the total.

zoombooleanDefault false

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