Docs Charts Radial & KPI

WaffleChart

React example follows below.
ts
import { WaffleChart } from "@grassroot/charts-react";
const values = [
{
id: "wind",
label: "Wind",
value: 28,
color: "var(--accent)",
},
{
id: "solar",
label: "Solar",
value: 19,
color: "var(--vs-warning)",
},
{
id: "nuclear",
label: "Nuclear",
value: 16,
color: "var(--vs-info)",
},
{
id: "hydro",
label: "Hydro",
value: 12,
color: "var(--vs-success)",
},
{
id: "biomass",
label: "Biomass",
value: 8,
color: "var(--vs-error)",
},
{
id: "storage",
label: "Storage",
value: 7,
color: "var(--vs-neutral-400)",
},
{
id: "interconnect",
label: "Interconnect",
value: 6,
color: "var(--accent)",
},
{
id: "gas",
label: "Gas peak",
value: 4,
color: "var(--vs-warning)",
},
];
export default function WaffleChartDemo() {
return (
<div>
<WaffleChart
data={values}
total={100}
ariaLabel="Great Britain electricity supply mix across eight sources, July 2026" />
</div>
);
}
ts
<script setup lang="ts">
import { WaffleChart } from "@grassroot/charts-vue";
const values = [
{
id: "wind",
label: "Wind",
value: 28,
color: "var(--accent)",
},
{
id: "solar",
label: "Solar",
value: 19,
color: "var(--vs-warning)",
},
{
id: "nuclear",
label: "Nuclear",
value: 16,
color: "var(--vs-info)",
},
{
id: "hydro",
label: "Hydro",
value: 12,
color: "var(--vs-success)",
},
{
id: "biomass",
label: "Biomass",
value: 8,
color: "var(--vs-error)",
},
{
id: "storage",
label: "Storage",
value: 7,
color: "var(--vs-neutral-400)",
},
{
id: "interconnect",
label: "Interconnect",
value: 6,
color: "var(--accent)",
},
{
id: "gas",
label: "Gas peak",
value: 4,
color: "var(--vs-warning)",
},
];
</script>
<template>
<WaffleChart
:data="values"
:total="100"
aria-label="Great Britain electricity supply mix across eight sources, July 2026" />
</template>
ts
import { ChangeDetectionStrategy, Component } from "@angular/core";
import { GrassrootWaffleChart } from "@grassroot/charts-angular";
@Component({
selector: "app-waffle-chart-chart-demo",
standalone: true,
imports: [GrassrootWaffleChart],
changeDetection: ChangeDetectionStrategy.OnPush,
template: `<grassroot-waffle-chart
[data]="values"
[total]="100"
ariaLabel="Great Britain electricity supply mix across eight sources, July 2026"
/>`,
})
export class WaffleChartDemoComponent {
readonly values = [
{
id: "wind",
label: "Wind",
value: 28,
color: "var(--accent)",
},
{
id: "solar",
label: "Solar",
value: 19,
color: "var(--vs-warning)",
},
{
id: "nuclear",
label: "Nuclear",
value: 16,
color: "var(--vs-info)",
},
{
id: "hydro",
label: "Hydro",
value: 12,
color: "var(--vs-success)",
},
{
id: "biomass",
label: "Biomass",
value: 8,
color: "var(--vs-error)",
},
{
id: "storage",
label: "Storage",
value: 7,
color: "var(--vs-neutral-400)",
},
{
id: "interconnect",
label: "Interconnect",
value: 6,
color: "var(--accent)",
},
{
id: "gas",
label: "Gas peak",
value: 4,
color: "var(--vs-warning)",
},
];
}
export default WaffleChartDemoComponent;
ts
<script lang="ts">
import { WaffleChart } from "@grassroot/charts-svelte";
const values = [
{
id: "wind",
label: "Wind",
value: 28,
color: "var(--accent)",
},
{
id: "solar",
label: "Solar",
value: 19,
color: "var(--vs-warning)",
},
{
id: "nuclear",
label: "Nuclear",
value: 16,
color: "var(--vs-info)",
},
{
id: "hydro",
label: "Hydro",
value: 12,
color: "var(--vs-success)",
},
{
id: "biomass",
label: "Biomass",
value: 8,
color: "var(--vs-error)",
},
{
id: "storage",
label: "Storage",
value: 7,
color: "var(--vs-neutral-400)",
},
{
id: "interconnect",
label: "Interconnect",
value: 6,
color: "var(--accent)",
},
{
id: "gas",
label: "Gas peak",
value: 4,
color: "var(--vs-warning)",
},
];
</script>
<WaffleChart
data={values}
total={100}
ariaLabel="Great Britain electricity supply mix across eight sources, July 2026" />
ts
/** @jsxImportSource solid-js */
import { WaffleChart } from "@grassroot/charts-solid";
const values = [
{
id: "wind",
label: "Wind",
value: 28,
color: "var(--accent)",
},
{
id: "solar",
label: "Solar",
value: 19,
color: "var(--vs-warning)",
},
{
id: "nuclear",
label: "Nuclear",
value: 16,
color: "var(--vs-info)",
},
{
id: "hydro",
label: "Hydro",
value: 12,
color: "var(--vs-success)",
},
{
id: "biomass",
label: "Biomass",
value: 8,
color: "var(--vs-error)",
},
{
id: "storage",
label: "Storage",
value: 7,
color: "var(--vs-neutral-400)",
},
{
id: "interconnect",
label: "Interconnect",
value: 6,
color: "var(--accent)",
},
{
id: "gas",
label: "Gas peak",
value: 4,
color: "var(--vs-warning)",
},
];
export default function WaffleChartDemo() {
return (
<WaffleChart
data={values}
total={100}
ariaLabel="Great Britain electricity supply mix across eight sources, July 2026" />
);
}

Installation

API Reference

Import

import { WaffleChart } from "@grassroot/charts-react";

Props

Prop
Type
Default
Requirement
Description
data
readonly ChartValueDatum[]
—
required
—
total
number | undefined
—
optional
—
columns
number | undefined
—
optional
—
legend
boolean | import("@grassroot/chart-spec").LegendConfig | undefined
—
optional
—
tooltip
boolean | import("./base").ExpandedChartTooltipConfig<unknown> | undefined
—
optional
—
animation
boolean | import("./base").ExpandedChartAnimationConfig | undefined
—
optional
—
onHiddenSeriesChange
((ids: readonly string[]) => void) | undefined
—
optional
—
onActiveDatumChange
((id: string | null) => void) | undefined
—
optional
—
renderer
ChartRenderer | undefined
—
optional
—
className
string | undefined
—
optional
—
theme
import("@grassroot/theme").PartialChartTheme | undefined
—
optional
—
title
string | undefined
—
optional
—
description
string | undefined
—
optional
—
ariaLabel
string | undefined
—
optional
—
Prop
data
Type
readonly ChartValueDatum[]
Default
—
Requirement
required
Description
—
Prop
total
Type
number | undefined
Default
—
Requirement
optional
Description
—
Prop
columns
Type
number | undefined
Default
—
Requirement
optional
Description
—
Prop
legend
Type
boolean | import("@grassroot/chart-spec").LegendConfig | undefined
Default
—
Requirement
optional
Description
—
Prop
tooltip
Type
boolean | import("./base").ExpandedChartTooltipConfig<unknown> | undefined
Default
—
Requirement
optional
Description
—
Prop
animation
Type
boolean | import("./base").ExpandedChartAnimationConfig | undefined
Default
—
Requirement
optional
Description
—
Prop
onHiddenSeriesChange
Type
((ids: readonly string[]) => void) | undefined
Default
—
Requirement
optional
Description
—
Prop
onActiveDatumChange
Type
((id: string | null) => void) | undefined
Default
—
Requirement
optional
Description
—
Prop
renderer
Type
ChartRenderer | undefined
Default
—
Requirement
optional
Description
—
Prop
className
Type
string | undefined
Default
—
Requirement
optional
Description
—
Prop
theme
Type
import("@grassroot/theme").PartialChartTheme | undefined
Default
—
Requirement
optional
Description
—
Prop
title
Type
string | undefined
Default
—
Requirement
optional
Description
—
Prop
description
Type
string | undefined
Default
—
Requirement
optional
Description
—
Prop
ariaLabel
Type
string | undefined
Default
—
Requirement
optional
Description
—
Prop
keyboardNavigation
Type
boolean | undefined
Default
—
Requirement
optional
Description
—
Prop
width
Type
number | undefined
Default
—
Requirement
optional
Description
—
Prop
height
Type
number | undefined
Default
—
Requirement
optional
Description
—
Prop
gpuBackend
Type
ChartGpuBackend | undefined
Default
—
Requirement
optional
Description
—
Prop
rendererStrategy
Type
Partial<import("@grassroot/core").ChartRendererStrategy> | undefined
Default
—
Requirement
optional
Description
—
Prop
renderPlanMode
Type
"svg" | "host" | undefined
Default
—
Requirement
optional
Description
—
Prop
showGrid
Type
boolean | undefined
Default
—
Requirement
optional
Description
—
Prop
interactive
Type
boolean | undefined
Default
—
Requirement
optional
Description
Gates every pointer/keyboard interaction the shell owns (hit-test on pointer move, focus-to-first, arrow navigation, Escape) and, with `keyboardNavigation`, whether the plot surface is focusable at all.
Prop
hiddenSeries
Type
readonly string[] | undefined
Default
—
Requirement
optional
Description
—
Prop
defaultHiddenSeries
Type
readonly string[] | undefined
Default
—
Requirement
optional
Description
—
Prop
activeDatum
Type
string | null | undefined
Default
—
Requirement
optional
Description
—
Prop
defaultActiveDatum
Type
string | null | undefined
Default
—
Requirement
optional
Description
Uncontrolled initial value for the `activeDatum`/`onActiveDatumChange` pair.
Prop
speed
Type
number | undefined
Default
—
Requirement
optional
Description
Playback-speed multiplier for entrance/ambient motion.
Prop
morphDurationMs
Type
number | undefined
Default
—
Requirement
optional
Description
How long a dataset change tweens, in milliseconds.
Prop
replayToken
Type
string | number | undefined
Default
—
Requirement
optional
Description
Changing this value replays the entrance animation.

Events

EventPayload
onHiddenSeriesChange((ids: readonly string[]) => void) | undefined
onActiveDatumChange((id: string | null) => void) | undefined

Content regions

  • children
  • dataSummary

Native attributes

Standard DOM and ARIA attributes not listed above spread onto the root element.

Import

import { WaffleChart } from "@grassroot/charts-vue";

Props

Prop
Type
Default
Requirement
className
string | undefined
—
optional
gpuBackend
"auto" | "webgpu" | "webgl2" | undefined
—
optional
width
number | undefined
—
optional
height
number | undefined
—
optional
renderer
ChartRenderer | undefined
—
optional
rendererStrategy
Partial<ChartRendererStrategy> | undefined
—
optional
renderPlanMode
"svg" | "host" | undefined
"host"
optional
showGrid
boolean | undefined
—
optional
legend
boolean | LegendConfig | undefined
false
optional
tooltip
boolean | TooltipBehaviorConfig | undefined
true
optional
animation
ChartAnimationInput | undefined
—
optional
interactive
boolean | undefined
true
optional
keyboardNavigation
boolean | undefined
true
optional
hiddenSeries
readonly string[] | undefined
—
optional
Prop
className
Type
string | undefined
Default
—
Requirement
optional
Prop
gpuBackend
Type
"auto" | "webgpu" | "webgl2" | undefined
Default
—
Requirement
optional
Prop
width
Type
number | undefined
Default
—
Requirement
optional
Prop
height
Type
number | undefined
Default
—
Requirement
optional
Prop
renderer
Type
ChartRenderer | undefined
Default
—
Requirement
optional
Prop
rendererStrategy
Type
Partial<ChartRendererStrategy> | undefined
Default
—
Requirement
optional
Prop
renderPlanMode
Type
"svg" | "host" | undefined
Default
"host"
Requirement
optional
Prop
showGrid
Type
boolean | undefined
Default
—
Requirement
optional
Prop
legend
Type
boolean | LegendConfig | undefined
Default
false
Requirement
optional
Prop
tooltip
Type
boolean | TooltipBehaviorConfig | undefined
Default
true
Requirement
optional
Prop
animation
Type
ChartAnimationInput | undefined
Default
—
Requirement
optional
Prop
interactive
Type
boolean | undefined
Default
true
Requirement
optional
Prop
keyboardNavigation
Type
boolean | undefined
Default
true
Requirement
optional
Prop
hiddenSeries
Type
readonly string[] | undefined
Default
—
Requirement
optional
Prop
defaultHiddenSeries
Type
readonly string[] | undefined
Default
() => []
Requirement
optional
Prop
activeDatum
Type
string | null | undefined
Default
—
Requirement
optional
Prop
defaultActiveDatum
Type
string | null | undefined
Default
—
Requirement
optional
Prop
speed
Type
number | undefined
Default
—
Requirement
optional
Prop
morphDurationMs
Type
number | undefined
Default
—
Requirement
optional
Prop
replayToken
Type
string | number | undefined
Default
—
Requirement
optional
Prop
theme
Type
PartialChartTheme | undefined
Default
—
Requirement
optional
Prop
title
Type
string | undefined
Default
—
Requirement
optional
Prop
description
Type
string | undefined
Default
—
Requirement
optional
Prop
ariaLabel
Type
string | undefined
Default
—
Requirement
optional
Prop
data
Type
readonly RadialKpiValueDatum[]
Default
—
Requirement
required
Prop
total
Type
number | undefined
Default
—
Requirement
optional
Prop
columns
Type
number | undefined
Default
10
Requirement
optional

Events

EventPayload
hiddenSeriesChange[ids: readonly string[]]
activeDatumChange[id: string | null]

Content regions

  • dataSummary
  • default

Import

import { ChangeDetectionStrategy, Component } from "@angular/core";
import { GrassrootWaffleChart } from "@grassroot/charts-angular";

Props

Prop
Type
Default
Requirement
renderer
ChartRenderer
—
optional
gpuBackend
ChartGpuBackend
—
optional
rendererStrategy
Partial<ChartRendererStrategy>
—
optional
renderPlanMode
"svg" | "host"
"host"
optional
ariaLabel
string
—
optional
title
string
—
optional
description
string
—
optional
theme
PartialChartTheme
—
optional
animation
ChartAnimationInput
—
optional
interactive
boolean
true
optional
keyboardNavigation
boolean
true
optional
tooltip
boolean | TooltipBehaviorConfig
true
optional
legend
boolean | LegendConfig
—
optional
hiddenSeries
readonly string[]
—
optional
Prop
renderer
Type
ChartRenderer
Default
—
Requirement
optional
Prop
gpuBackend
Type
ChartGpuBackend
Default
—
Requirement
optional
Prop
rendererStrategy
Type
Partial<ChartRendererStrategy>
Default
—
Requirement
optional
Prop
renderPlanMode
Type
"svg" | "host"
Default
"host"
Requirement
optional
Prop
ariaLabel
Type
string
Default
—
Requirement
optional
Prop
title
Type
string
Default
—
Requirement
optional
Prop
description
Type
string
Default
—
Requirement
optional
Prop
theme
Type
PartialChartTheme
Default
—
Requirement
optional
Prop
animation
Type
ChartAnimationInput
Default
—
Requirement
optional
Prop
interactive
Type
boolean
Default
true
Requirement
optional
Prop
keyboardNavigation
Type
boolean
Default
true
Requirement
optional
Prop
tooltip
Type
boolean | TooltipBehaviorConfig
Default
true
Requirement
optional
Prop
legend
Type
boolean | LegendConfig
Default
—
Requirement
optional
Prop
hiddenSeries
Type
readonly string[]
Default
—
Requirement
optional
Prop
defaultHiddenSeries
Type
readonly string[]
Default
[]
Requirement
optional
Prop
activeDatum
Type
string | null
Default
—
Requirement
optional
Prop
defaultActiveDatum
Type
string | null
Default
null
Requirement
optional
Prop
speed
Type
number
Default
—
Requirement
optional
Prop
morphDurationMs
Type
number
Default
—
Requirement
optional
Prop
replayToken
Type
string | number
Default
—
Requirement
optional
Prop
data
Type
readonly RadialKpiValueDatum[]
Default
—
Requirement
required
Prop
total
Type
number
Default
—
Requirement
optional
Prop
columns
Type
number
Default
10
Requirement
optional
Prop
width
Type
number
Default
—
Requirement
optional
Prop
height
Type
number
Default
—
Requirement
optional
Prop
showGrid
Type
boolean
Default
—
Requirement
optional
Prop
className
Type
string
Default
—
Requirement
optional

Events

EventPayload
activeDatumChangestring | null
hiddenSeriesChangereadonly string[]

Content regions

  • dataSummary
  • default

Import

import { WaffleChart } from "@grassroot/charts-svelte";

Props

Prop
Type
Default
Requirement
data
readonly RadialKpiValueDatum[]
—
required
total
number
—
optional
columns
number
10
optional
onHiddenSeriesChange
(ids: readonly string[]) => void
—
optional
onActiveDatumChange
(id: string | null) => void
—
optional
class
string
—
optional
style
string
—
optional
width
number
—
optional
height
number
—
optional
renderer
ChartRenderer
—
optional
gpuBackend
ChartGpuBackend
—
optional
rendererStrategy
Partial<ChartRendererStrategy>
—
optional
renderPlanMode
"svg" | "host"
"host"
optional
showGrid
boolean
—
optional
Prop
data
Type
readonly RadialKpiValueDatum[]
Default
—
Requirement
required
Prop
total
Type
number
Default
—
Requirement
optional
Prop
columns
Type
number
Default
10
Requirement
optional
Prop
onHiddenSeriesChange
Type
(ids: readonly string[]) => void
Default
—
Requirement
optional
Prop
onActiveDatumChange
Type
(id: string | null) => void
Default
—
Requirement
optional
Prop
class
Type
string
Default
—
Requirement
optional
Prop
style
Type
string
Default
—
Requirement
optional
Prop
width
Type
number
Default
—
Requirement
optional
Prop
height
Type
number
Default
—
Requirement
optional
Prop
renderer
Type
ChartRenderer
Default
—
Requirement
optional
Prop
gpuBackend
Type
ChartGpuBackend
Default
—
Requirement
optional
Prop
rendererStrategy
Type
Partial<ChartRendererStrategy>
Default
—
Requirement
optional
Prop
renderPlanMode
Type
"svg" | "host"
Default
"host"
Requirement
optional
Prop
showGrid
Type
boolean
Default
—
Requirement
optional
Prop
legend
Type
boolean | LegendConfig
Default
false
Requirement
optional
Prop
tooltip
Type
boolean | TooltipBehaviorConfig
Default
true
Requirement
optional
Prop
animation
Type
ChartAnimationInput
Default
—
Requirement
optional
Prop
interactive
Type
boolean
Default
true
Requirement
optional
Prop
keyboardNavigation
Type
boolean
Default
true
Requirement
optional
Prop
hiddenSeries
Type
readonly string[]
Default
—
Requirement
optional
Prop
defaultHiddenSeries
Type
readonly string[]
Default
—
Requirement
optional
Prop
activeDatum
Type
string | null
Default
—
Requirement
optional
Prop
defaultActiveDatum
Type
string | null
Default
—
Requirement
optional
Prop
speed
Type
number
Default
—
Requirement
optional
Prop
morphDurationMs
Type
number
Default
—
Requirement
optional
Prop
replayToken
Type
string | number
Default
—
Requirement
optional
Prop
theme
Type
PartialChartTheme
Default
—
Requirement
optional
Prop
title
Type
string
Default
—
Requirement
optional
Prop
description
Type
string
Default
—
Requirement
optional
Prop
ariaLabel
Type
string
Default
—
Requirement
optional

Events

EventPayload
onHiddenSeriesChange(ids: readonly string[]) => void
onActiveDatumChange(id: string | null) => void

Content regions

  • children
  • dataSummary

Import

import { WaffleChart } from "@grassroot/charts-solid";

Props

Prop
Type
Default
Requirement
data
readonly RadialKpiValueDatum[]
—
required
total
number
—
optional
columns
number
10
optional
onActiveDatumChange
(id: string | null) => void
—
optional
onHiddenSeriesChange
(ids: readonly string[]) => void
—
optional
class
string
—
optional
style
JSX.CSSProperties
—
optional
width
number
—
optional
height
number
—
optional
renderer
ChartRenderer
—
optional
gpuBackend
ChartGpuBackend
"auto"
optional
rendererStrategy
Partial<ChartRendererStrategy>
—
optional
renderPlanMode
"svg" | "host"
"host"
optional
showGrid
boolean
false
optional
Prop
data
Type
readonly RadialKpiValueDatum[]
Default
—
Requirement
required
Prop
total
Type
number
Default
—
Requirement
optional
Prop
columns
Type
number
Default
10
Requirement
optional
Prop
onActiveDatumChange
Type
(id: string | null) => void
Default
—
Requirement
optional
Prop
onHiddenSeriesChange
Type
(ids: readonly string[]) => void
Default
—
Requirement
optional
Prop
class
Type
string
Default
—
Requirement
optional
Prop
style
Type
JSX.CSSProperties
Default
—
Requirement
optional
Prop
width
Type
number
Default
—
Requirement
optional
Prop
height
Type
number
Default
—
Requirement
optional
Prop
renderer
Type
ChartRenderer
Default
—
Requirement
optional
Prop
gpuBackend
Type
ChartGpuBackend
Default
"auto"
Requirement
optional
Prop
rendererStrategy
Type
Partial<ChartRendererStrategy>
Default
—
Requirement
optional
Prop
renderPlanMode
Type
"svg" | "host"
Default
"host"
Requirement
optional
Prop
showGrid
Type
boolean
Default
false
Requirement
optional
Prop
legend
Type
boolean | LegendConfig
Default
—
Requirement
optional
Prop
tooltip
Type
boolean | TooltipBehaviorConfig
Default
—
Requirement
optional
Prop
animation
Type
ChartAnimationInput
Default
—
Requirement
optional
Prop
interactive
Type
boolean
Default
—
Requirement
optional
Prop
keyboardNavigation
Type
boolean
Default
—
Requirement
optional
Prop
hiddenSeries
Type
readonly string[]
Default
—
Requirement
optional
Prop
defaultHiddenSeries
Type
readonly string[]
Default
—
Requirement
optional
Prop
activeDatum
Type
string | null
Default
—
Requirement
optional
Prop
defaultActiveDatum
Type
string | null
Default
—
Requirement
optional
Prop
speed
Type
number
Default
—
Requirement
optional
Prop
morphDurationMs
Type
number
Default
—
Requirement
optional
Prop
replayToken
Type
string | number
Default
—
Requirement
optional
Prop
theme
Type
PartialChartTheme
Default
—
Requirement
optional
Prop
title
Type
string
Default
—
Requirement
optional
Prop
description
Type
string
Default
—
Requirement
optional
Prop
ariaLabel
Type
string
Default
—
Requirement
optional

Events

EventPayload
onActiveDatumChange(id: string | null) => void
onHiddenSeriesChange(ids: readonly string[]) => void

Content regions

  • children
  • dataSummary