- Prop
data- Type
readonly GroupedBarGroup[]- Default
- —
- Requirement
- required
- Description
- —
Docs Charts Cartesian & statistical
GroupedBarChart
React example follows below.
Vue example follows below.
Angular example follows below.
Svelte example follows below.
Solid example follows below.
- surface
- —
- marks
- —
- size
- —
- value
- —
ts
const groupedBarChartFixture = { id: "grouped-bar-chart", data: [ { label: "Birmingham", values: [{ series: "July 2024", value: 1420 }, { series: "July 2025", value: 1684 }, { series: "July 2026", value: 1968 }] }, { label: "Bristol", values: [{ series: "July 2024", value: 1088 }, { series: "July 2025", value: 1242 }, { series: "July 2026", value: 1470 }] }, { label: "Cardiff", values: [{ series: "July 2024", value: 742 }, { series: "July 2025", value: 886 }, { series: "July 2026", value: 1044 }] }, { label: "Edinburgh", values: [{ series: "July 2024", value: 916 }, { series: "July 2025", value: 1088 }, { series: "July 2026", value: 1296 }] }, { label: "Glasgow", values: [{ series: "July 2024", value: 964 }, { series: "July 2025", value: 1096 }, { series: "July 2026", value: 1330 }] }, { label: "Leeds", values: [{ series: "July 2024", value: 1312 }, { series: "July 2025", value: 1518 }, { series: "July 2026", value: 1792 }] }, { label: "Liverpool", values: [{ series: "July 2024", value: 808 }, { series: "July 2025", value: 974 }, { series: "July 2026", value: 1162 }] }, { label: "London", values: [{ series: "July 2024", value: 1864 }, { series: "July 2025", value: 2146 }, { series: "July 2026", value: 2522 }] }, { label: "Manchester", values: [{ series: "July 2024", value: 1548 }, { series: "July 2025", value: 1782 }, { series: "July 2026", value: 2094 }] }, { label: "Newcastle", values: [{ series: "July 2024", value: 688 }, { series: "July 2025", value: 812 }, { series: "July 2026", value: 958 }] }, ], ariaLabel: "Parcel deliveries by fulfilment centre, July 2024 to July 2026", tooltip: true, legend: true,}; import { GroupedBarChart } from "@grassroot/charts-react"; export default function GroupedBarChartDemo() { return ( <div> <GroupedBarChart {...groupedBarChartFixture} /> </div> );}- surface
- —
- marks
- —
- size
- —
- value
- —
ts
<script setup lang="ts">const groupedBarChartFixture = { id: "grouped-bar-chart", data: [ { label: "Birmingham", values: [{ series: "July 2024", value: 1420 }, { series: "July 2025", value: 1684 }, { series: "July 2026", value: 1968 }] }, { label: "Bristol", values: [{ series: "July 2024", value: 1088 }, { series: "July 2025", value: 1242 }, { series: "July 2026", value: 1470 }] }, { label: "Cardiff", values: [{ series: "July 2024", value: 742 }, { series: "July 2025", value: 886 }, { series: "July 2026", value: 1044 }] }, { label: "Edinburgh", values: [{ series: "July 2024", value: 916 }, { series: "July 2025", value: 1088 }, { series: "July 2026", value: 1296 }] }, { label: "Glasgow", values: [{ series: "July 2024", value: 964 }, { series: "July 2025", value: 1096 }, { series: "July 2026", value: 1330 }] }, { label: "Leeds", values: [{ series: "July 2024", value: 1312 }, { series: "July 2025", value: 1518 }, { series: "July 2026", value: 1792 }] }, { label: "Liverpool", values: [{ series: "July 2024", value: 808 }, { series: "July 2025", value: 974 }, { series: "July 2026", value: 1162 }] }, { label: "London", values: [{ series: "July 2024", value: 1864 }, { series: "July 2025", value: 2146 }, { series: "July 2026", value: 2522 }] }, { label: "Manchester", values: [{ series: "July 2024", value: 1548 }, { series: "July 2025", value: 1782 }, { series: "July 2026", value: 2094 }] }, { label: "Newcastle", values: [{ series: "July 2024", value: 688 }, { series: "July 2025", value: 812 }, { series: "July 2026", value: 958 }] }, ], ariaLabel: "Parcel deliveries by fulfilment centre, July 2024 to July 2026", tooltip: true, legend: true,}; import { GroupedBarChart } from "@grassroot/charts-vue";</script><template><GroupedBarChart v-bind="groupedBarChartFixture" /></template>- surface
- —
- marks
- —
- size
- —
- value
- —
ts
import { ChangeDetectionStrategy, Component } from "@angular/core";const groupedBarChartFixture = { id: "grouped-bar-chart", data: [ { label: "Birmingham", values: [{ series: "July 2024", value: 1420 }, { series: "July 2025", value: 1684 }, { series: "July 2026", value: 1968 }] }, { label: "Bristol", values: [{ series: "July 2024", value: 1088 }, { series: "July 2025", value: 1242 }, { series: "July 2026", value: 1470 }] }, { label: "Cardiff", values: [{ series: "July 2024", value: 742 }, { series: "July 2025", value: 886 }, { series: "July 2026", value: 1044 }] }, { label: "Edinburgh", values: [{ series: "July 2024", value: 916 }, { series: "July 2025", value: 1088 }, { series: "July 2026", value: 1296 }] }, { label: "Glasgow", values: [{ series: "July 2024", value: 964 }, { series: "July 2025", value: 1096 }, { series: "July 2026", value: 1330 }] }, { label: "Leeds", values: [{ series: "July 2024", value: 1312 }, { series: "July 2025", value: 1518 }, { series: "July 2026", value: 1792 }] }, { label: "Liverpool", values: [{ series: "July 2024", value: 808 }, { series: "July 2025", value: 974 }, { series: "July 2026", value: 1162 }] }, { label: "London", values: [{ series: "July 2024", value: 1864 }, { series: "July 2025", value: 2146 }, { series: "July 2026", value: 2522 }] }, { label: "Manchester", values: [{ series: "July 2024", value: 1548 }, { series: "July 2025", value: 1782 }, { series: "July 2026", value: 2094 }] }, { label: "Newcastle", values: [{ series: "July 2024", value: 688 }, { series: "July 2025", value: 812 }, { series: "July 2026", value: 958 }] }, ], ariaLabel: "Parcel deliveries by fulfilment centre, July 2024 to July 2026", tooltip: true, legend: true,}; import { GrassrootGroupedBarChart } from "@grassroot/charts-angular";@Component({ selector: "app-grouped-bar-chart-chart-demo", standalone: true, imports: [GrassrootGroupedBarChart], changeDetection: ChangeDetectionStrategy.OnPush, template: `<grassroot-grouped-bar-chart [data]="fixture.data" [ariaLabel]="fixture.ariaLabel" [tooltip]="fixture.tooltip" [legend]="fixture.legend" />`,})export class GroupedBarChartDemoComponent { readonly fixture = groupedBarChartFixture;}export default GroupedBarChartDemoComponent;- surface
- —
- marks
- —
- size
- —
- value
- —
ts
<script lang="ts"> const groupedBarChartFixture = { id: "grouped-bar-chart", data: [ { label: "Birmingham", values: [{ series: "July 2024", value: 1420 }, { series: "July 2025", value: 1684 }, { series: "July 2026", value: 1968 }] }, { label: "Bristol", values: [{ series: "July 2024", value: 1088 }, { series: "July 2025", value: 1242 }, { series: "July 2026", value: 1470 }] }, { label: "Cardiff", values: [{ series: "July 2024", value: 742 }, { series: "July 2025", value: 886 }, { series: "July 2026", value: 1044 }] }, { label: "Edinburgh", values: [{ series: "July 2024", value: 916 }, { series: "July 2025", value: 1088 }, { series: "July 2026", value: 1296 }] }, { label: "Glasgow", values: [{ series: "July 2024", value: 964 }, { series: "July 2025", value: 1096 }, { series: "July 2026", value: 1330 }] }, { label: "Leeds", values: [{ series: "July 2024", value: 1312 }, { series: "July 2025", value: 1518 }, { series: "July 2026", value: 1792 }] }, { label: "Liverpool", values: [{ series: "July 2024", value: 808 }, { series: "July 2025", value: 974 }, { series: "July 2026", value: 1162 }] }, { label: "London", values: [{ series: "July 2024", value: 1864 }, { series: "July 2025", value: 2146 }, { series: "July 2026", value: 2522 }] }, { label: "Manchester", values: [{ series: "July 2024", value: 1548 }, { series: "July 2025", value: 1782 }, { series: "July 2026", value: 2094 }] }, { label: "Newcastle", values: [{ series: "July 2024", value: 688 }, { series: "July 2025", value: 812 }, { series: "July 2026", value: 958 }] }, ], ariaLabel: "Parcel deliveries by fulfilment centre, July 2024 to July 2026", tooltip: true, legend: true, }; import { GroupedBarChart } from "@grassroot/charts-svelte";</script> <GroupedBarChart {...groupedBarChartFixture} />- surface
- —
- marks
- —
- size
- —
- value
- —
ts
/** @jsxImportSource solid-js */const groupedBarChartFixture = { id: "grouped-bar-chart", data: [ { label: "Birmingham", values: [{ series: "July 2024", value: 1420 }, { series: "July 2025", value: 1684 }, { series: "July 2026", value: 1968 }] }, { label: "Bristol", values: [{ series: "July 2024", value: 1088 }, { series: "July 2025", value: 1242 }, { series: "July 2026", value: 1470 }] }, { label: "Cardiff", values: [{ series: "July 2024", value: 742 }, { series: "July 2025", value: 886 }, { series: "July 2026", value: 1044 }] }, { label: "Edinburgh", values: [{ series: "July 2024", value: 916 }, { series: "July 2025", value: 1088 }, { series: "July 2026", value: 1296 }] }, { label: "Glasgow", values: [{ series: "July 2024", value: 964 }, { series: "July 2025", value: 1096 }, { series: "July 2026", value: 1330 }] }, { label: "Leeds", values: [{ series: "July 2024", value: 1312 }, { series: "July 2025", value: 1518 }, { series: "July 2026", value: 1792 }] }, { label: "Liverpool", values: [{ series: "July 2024", value: 808 }, { series: "July 2025", value: 974 }, { series: "July 2026", value: 1162 }] }, { label: "London", values: [{ series: "July 2024", value: 1864 }, { series: "July 2025", value: 2146 }, { series: "July 2026", value: 2522 }] }, { label: "Manchester", values: [{ series: "July 2024", value: 1548 }, { series: "July 2025", value: 1782 }, { series: "July 2026", value: 2094 }] }, { label: "Newcastle", values: [{ series: "July 2024", value: 688 }, { series: "July 2025", value: 812 }, { series: "July 2026", value: 958 }] }, ], ariaLabel: "Parcel deliveries by fulfilment centre, July 2024 to July 2026", tooltip: true, legend: true,}; import { GroupedBarChart } from "@grassroot/charts-solid";export default function GroupedBarChartDemo() { return <GroupedBarChart {...groupedBarChartFixture} />;}Installation
API Reference
Import
import { GroupedBarChart } from "@grassroot/charts-react";
Props
Prop
Type
Default
Requirement
Description
datareadonly GroupedBarGroup[]—
required
—
legendboolean | import("@grassroot/chart-spec").LegendConfig | undefined—
optional
—
tooltipboolean | import("./base").ExpandedChartTooltipConfig<unknown> | undefined—
optional
—
animationboolean | import("./base").ExpandedChartAnimationConfig | undefined—
optional
—
onHiddenSeriesChange((ids: readonly string[]) => void) | undefined—
optional
—
onActiveDatumChange((id: string | null) => void) | undefined—
optional
—
rendererChartRenderer | undefined—
optional
—
classNamestring | undefined—
optional
—
themeimport("@grassroot/theme").PartialChartTheme | undefined—
optional
—
titlestring | undefined—
optional
—
descriptionstring | undefined—
optional
—
ariaLabelstring | undefined—
optional
—
widthnumber | undefined—
optional
—
- 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
| Event | Payload |
|---|---|
onHiddenSeriesChange | ((ids: readonly string[]) => void) | undefined |
onActiveDatumChange | ((id: string | null) => void) | undefined |
Content regions
childrendataSummary
Native attributes
Standard DOM and ARIA attributes not listed above spread onto the root element.
Import
import { GroupedBarChart } from "@grassroot/charts-vue";
Props
Prop
Type
Default
Requirement
classNamestring | undefined—
optional
gpuBackend"auto" | "webgpu" | "webgl2" | undefined—
optional
widthnumber | undefined—
optional
heightnumber | undefined—
optional
rendererChartRenderer | undefined—
optional
rendererStrategyPartial<ChartRendererStrategy> | undefined—
optional
renderPlanMode"svg" | "host" | undefined"host"optional
showGridboolean | undefinedfalseoptional
legendboolean | LegendConfig | undefinedtrueoptional
tooltipboolean | TooltipBehaviorConfig | undefinedtrueoptional
animationChartAnimationInput | undefined—
optional
interactiveboolean | undefinedtrueoptional
- 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
false- Requirement
- optional
- Prop
legend- Type
boolean | LegendConfig | undefined- Default
true- 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 GroupedBarGroupDatum[]- Default
- —
- Requirement
- required
Events
| Event | Payload |
|---|---|
hiddenSeriesChange | [ids: readonly string[]] |
activeDatumChange | [id: string | null] |
Content regions
dataSummarydefault
Import
import { ChangeDetectionStrategy, Component } from "@angular/core";
import { GrassrootGroupedBarChart } from "@grassroot/charts-angular";
Props
Prop
Type
Default
Requirement
rendererChartRenderer—
optional
gpuBackendChartGpuBackend—
optional
rendererStrategyPartial<ChartRendererStrategy>—
optional
renderPlanMode"svg" | "host""host"optional
ariaLabelstring—
optional
titlestring—
optional
descriptionstring—
optional
themePartialChartTheme—
optional
animationChartAnimationInput—
optional
interactivebooleantrueoptional
tooltipboolean | TooltipBehaviorConfigtrueoptional
legendboolean | LegendConfig | undefinedtrueoptional
- 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 GroupedBarGroupDatum[]- Default
- —
- Requirement
- required
- Prop
width- Type
number- Default
- —
- Requirement
- optional
- Prop
height- Type
number- Default
- —
- Requirement
- optional
- Prop
showGrid- Type
boolean- Default
false- Requirement
- optional
- Prop
className- Type
string- Default
- —
- Requirement
- optional
- Prop
legend- Type
boolean | LegendConfig | undefined- Default
true- Requirement
- optional
Events
| Event | Payload |
|---|---|
activeDatumChange | string | null |
hiddenSeriesChange | readonly string[] |
Content regions
dataSummarydefault
Import
import { GroupedBarChart } from "@grassroot/charts-svelte";
Props
Prop
Type
Default
Requirement
datareadonly GroupedBarGroupDatum[]—
required
onHiddenSeriesChange(ids: readonly string[]) => void—
optional
onActiveDatumChange(id: string | null) => void—
optional
classstring—
optional
stylestring—
optional
widthnumber—
optional
heightnumber—
optional
rendererChartRenderer—
optional
gpuBackendChartGpuBackend—
optional
rendererStrategyPartial<ChartRendererStrategy>—
optional
renderPlanMode"svg" | "host""host"optional
showGridbooleanfalseoptional
legendboolean | LegendConfigtrueoptional
tooltipboolean | TooltipBehaviorConfigtrueoptional
- Prop
data- Type
readonly GroupedBarGroupDatum[]- Default
- —
- Requirement
- required
- 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
false- Requirement
- optional
- Prop
legend- Type
boolean | LegendConfig- Default
true- 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
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
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
| Event | Payload |
|---|---|
onHiddenSeriesChange | (ids: readonly string[]) => void |
onActiveDatumChange | (id: string | null) => void |
Content regions
childrendataSummary
Import
import { GroupedBarChart } from "@grassroot/charts-solid";
Props
Prop
Type
Default
Requirement
datareadonly GroupedBarGroupDatum[]—
required
onActiveDatumChange(id: string | null) => void—
optional
onHiddenSeriesChange(ids: readonly string[]) => void—
optional
classstring—
optional
styleJSX.CSSProperties—
optional
widthnumber—
optional
heightnumber—
optional
rendererChartRenderer—
optional
gpuBackendChartGpuBackend"auto"optional
rendererStrategyPartial<ChartRendererStrategy>—
optional
renderPlanMode"svg" | "host""host"optional
showGridbooleanfalseoptional
legendboolean | LegendConfigtrueoptional
tooltipboolean | TooltipBehaviorConfig—
optional
- Prop
data- Type
readonly GroupedBarGroupDatum[]- Default
- —
- Requirement
- required
- 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
true- 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
| Event | Payload |
|---|---|
onActiveDatumChange | (id: string | null) => void |
onHiddenSeriesChange | (ids: readonly string[]) => void |
Content regions
childrendataSummary