Proportion · Intermediate
Waffle chart
Proportion on a 100-cell grid.
- Use when
- A share reads better as a count, like '38 out of 100'
- Avoid when
- More than 4 items, or differences under 1% matter
Try it
04
Waffle chart
Out of 100 customers
- New
- Returning
Hover over the chart, or Tab in and use the arrow keys to move between items. The numbers are sample data.
Variants
Named looks for this chart. Each one is the example above with a few options or fields changed. The CLI (ztd-charts example waffle --variant <id>) and the MCP server know the same names.
Grid only
Out of 100 customers
- New
- Returning
Fine grid
Out of 100 customers
- New
- Returning
Code
WaffleChart.tsx
import { ChartCard, WaffleChart } from "ztd-charts";
const data = [
{"segment":"New","customers":38},
{"segment":"Returning","customers":62},
];
export function Example() {
return (
<ChartCard number="04" title="Waffle chart" subtitle="Out of 100 customers" takeaway="Percent as 100 cells" level="intermediate" replay>
<WaffleChart
data={data}
label="segment"
value="customers"
summaryLabel="New customers"
summaryNote="62 returning"
/>
</ChartCard>
);
}
Props
<WaffleChart> takes these props. Rows marked Common work the same on every chart.
30 props
| Prop |
|---|
dataRequiredAn array of objects. Pass CSV, REST or database rows as they areobject[] |
labelRequiredItem name fieldstring | (d, i) => string |
valueRequiredValue fieldstring | (d, i) => number |
cellsNumber of cellsnumberDefault 100 |
columnsCells per rownumberDefault 10 |
totalValue of the whole. Defaults to the sumnumber |
summaryShow the big number on the rightbooleanDefault true |
summaryLabelCaption under the big numberstring |
summaryNoteSecond caption linestring |
heightCommonHeight in px. Without it, each chart picks a default that fits its widthnumber |
widthCommonFixed width in px. Without it, the chart fits its parentnumber |
highlightCommonItem to highlight. An index, a name, an array, or "max" | "min" | "first" | "last" | "none"number | string | (number|string)[] | "max" … |
formatCommonValue format. "number" | "integer" | "percent" (values are already percents: 42 → "42%") | "ratio" (0.42 → "42%") | "compact" | "currency" (KRW for Korean locales, otherwise USD; for another currency pass Intl options with currency) | "decimal" or Intl.NumberFormat options"number" | "percent" | "compact" | … |
unitCommonUnit appended to values. For example "%" or "ms"string |
localeCommonLocale for numbers, dates and the text a chart writes itself (tooltips, screen reader sentences). "ko" or "ko-*" switches to Korean. Falls back to the ThemeProvider localestringDefault "en-US" |
animateCommonEntry and update animationbooleanDefault true |
durationCommonAnimation length (ms)number |
easingCommonMotion curve"spring" | "easeOut" | "easeInOut" | "linear"Default "spring" |
staggerCommonDelay between items as they enter (ms)number |
reducedMotionCommon"auto" follows the OS setting. true always turns motion offanyDefault "auto" |
animateOnViewCommonPlay when the chart scrolls into viewbooleanDefault true |
showLabelsCommonLabels drawn on the chart (values and names)booleanDefault true |
tooltipCommonShow tooltips. { template: "{label} · {value} · owner {owner}" } writes them: {label}, {value}, {series} or any other column of the row. \n starts a new line, and a line with an empty value is left outtooltipDefault true |
syncIdCommonCharts with the same syncId show the hovered x together (line, area, bar, candlestick). <ChartGrid sync> sets one for every chart inside itstring |
ariaLabelCommonName for screen readersstring |
descriptionCommonDescription for screen readers. Built from the data when omittedstring |
onHoverCommonRuns when hover or keyboard focus moves to another item(e: ChartEvent | null) => void |
onClickCommonRuns on click, Enter or Space(e: ChartEvent) => void |
replayKeyCommonReplays the entry animation when it changesstring | number |
themeCommonChanges theme tokens for this chart onlyPartial<ChartTheme> |