Docs Charts Distribution

BeeswarmChart

import { BeeswarmChart } from "@grassroot/charts-react";
 
const orderDurations = [
  {
    label: "LON-1042",
    group: "London",
    value: 29,
  },
  {
    label: "LON-1057",
    group: "London",
    value: 31,
  },
  {
    label: "LON-1071",
    group: "London",
    value: 34,
  },
  {
    label: "LON-1086",
    group: "London",
    value: 36,
  },
  {
    label: "LON-1104",
    group: "London",
    value: 38,
  },
  {
    label: "LON-1122",
    group: "London",
    value: 39,
  },
  {
    label: "LON-1138",
    group: "London",
    value: 41,
  },
  {
    label: "LON-1154",
    group: "London",
    value: 43,
  },
  {
    label: "LON-1171",
    group: "London",
    value: 46,
  },
  {
    label: "LON-1188",
    group: "London",
    value: 49,
  },
  {
    label: "LON-1203",
    group: "London",
    value: 52,
  },
  {
    label: "LON-1220",
    group: "London",
    value: 58,
  },
  {
    label: "MAN-2031",
    group: "Manchester",
    value: 33,
  },
  {
    label: "MAN-2044",
    group: "Manchester",
    value: 35,
  },
  {
    label: "MAN-2062",
    group: "Manchester",
    value: 37,
  },
  {
    label: "MAN-2078",
    group: "Manchester",
    value: 38,
  },
  {
    label: "MAN-2093",
    group: "Manchester",
    value: 40,
  },
  {
    label: "MAN-2110",
    group: "Manchester",
    value: 42,
  },
  {
    label: "MAN-2126",
    group: "Manchester",
    value: 44,
  },
  {
    label: "MAN-2141",
    group: "Manchester",
    value: 47,
  },
  {
    label: "MAN-2158",
    group: "Manchester",
    value: 51,
  },
  {
    label: "MAN-2174",
    group: "Manchester",
    value: 54,
  },
  {
    label: "MAN-2190",
    group: "Manchester",
    value: 57,
  },
  {
    label: "MAN-2206",
    group: "Manchester",
    value: 63,
  },
  {
    label: "BRS-3018",
    group: "Bristol",
    value: 26,
  },
  {
    label: "BRS-3035",
    group: "Bristol",
    value: 28,
  },
  {
    label: "BRS-3051",
    group: "Bristol",
    value: 30,
  },
  {
    label: "BRS-3069",
    group: "Bristol",
    value: 32,
  },
  {
    label: "BRS-3088",
    group: "Bristol",
    value: 33,
  },
  {
    label: "BRS-3102",
    group: "Bristol",
    value: 35,
  },
  {
    label: "BRS-3119",
    group: "Bristol",
    value: 37,
  },
  {
    label: "BRS-3134",
    group: "Bristol",
    value: 40,
  },
  {
    label: "BRS-3150",
    group: "Bristol",
    value: 43,
  },
  {
    label: "BRS-3166",
    group: "Bristol",
    value: 46,
  },
  {
    label: "BRS-3182",
    group: "Bristol",
    value: 49,
  },
  {
    label: "BRS-3198",
    group: "Bristol",
    value: 55,
  },
  {
    label: "LDS-4011",
    group: "Leeds",
    value: 32,
  },
  {
    label: "LDS-4028",
    group: "Leeds",
    value: 34,
  },
  {
    label: "LDS-4044",
    group: "Leeds",
    value: 36,
  },
  {
    label: "LDS-4061",
    group: "Leeds",
    value: 38,
  },
  {
    label: "LDS-4077",
    group: "Leeds",
    value: 39,
  },
  {
    label: "LDS-4093",
    group: "Leeds",
    value: 41,
  },
  {
    label: "LDS-4110",
    group: "Leeds",
    value: 44,
  },
  {
    label: "LDS-4126",
    group: "Leeds",
    value: 47,
  },
  {
    label: "LDS-4142",
    group: "Leeds",
    value: 50,
  },
  {
    label: "LDS-4159",
    group: "Leeds",
    value: 53,
  },
  {
    label: "LDS-4175",
    group: "Leeds",
    value: 56,
  },
  {
    label: "LDS-4191",
    group: "Leeds",
    value: 61,
  },
];
 
export default function BeeswarmChartDemo() {
  return (
    <div>
      <BeeswarmChart
        points={orderDurations}
        ariaLabel="Order fulfilment times in minutes across London, Manchester, Bristol, and Leeds distribution centres, July 2026" />
    </div>
  );
}

<script setup lang="ts">
import { BeeswarmChart } from "@grassroot/charts-vue";
 
const orderDurations = [
  {
    label: "LON-1042",
    group: "London",
    value: 29,
  },
  {
    label: "LON-1057",
    group: "London",
    value: 31,
  },
  {
    label: "LON-1071",
    group: "London",
    value: 34,
  },
  {
    label: "LON-1086",
    group: "London",
    value: 36,
  },
  {
    label: "LON-1104",
    group: "London",
    value: 38,
  },
  {
    label: "LON-1122",
    group: "London",
    value: 39,
  },
  {
    label: "LON-1138",
    group: "London",
    value: 41,
  },
  {
    label: "LON-1154",
    group: "London",
    value: 43,
  },
  {
    label: "LON-1171",
    group: "London",
    value: 46,
  },
  {
    label: "LON-1188",
    group: "London",
    value: 49,
  },
  {
    label: "LON-1203",
    group: "London",
    value: 52,
  },
  {
    label: "LON-1220",
    group: "London",
    value: 58,
  },
  {
    label: "MAN-2031",
    group: "Manchester",
    value: 33,
  },
  {
    label: "MAN-2044",
    group: "Manchester",
    value: 35,
  },
  {
    label: "MAN-2062",
    group: "Manchester",
    value: 37,
  },
  {
    label: "MAN-2078",
    group: "Manchester",
    value: 38,
  },
  {
    label: "MAN-2093",
    group: "Manchester",
    value: 40,
  },
  {
    label: "MAN-2110",
    group: "Manchester",
    value: 42,
  },
  {
    label: "MAN-2126",
    group: "Manchester",
    value: 44,
  },
  {
    label: "MAN-2141",
    group: "Manchester",
    value: 47,
  },
  {
    label: "MAN-2158",
    group: "Manchester",
    value: 51,
  },
  {
    label: "MAN-2174",
    group: "Manchester",
    value: 54,
  },
  {
    label: "MAN-2190",
    group: "Manchester",
    value: 57,
  },
  {
    label: "MAN-2206",
    group: "Manchester",
    value: 63,
  },
  {
    label: "BRS-3018",
    group: "Bristol",
    value: 26,
  },
  {
    label: "BRS-3035",
    group: "Bristol",
    value: 28,
  },
  {
    label: "BRS-3051",
    group: "Bristol",
    value: 30,
  },
  {
    label: "BRS-3069",
    group: "Bristol",
    value: 32,
  },
  {
    label: "BRS-3088",
    group: "Bristol",
    value: 33,
  },
  {
    label: "BRS-3102",
    group: "Bristol",
    value: 35,
  },
  {
    label: "BRS-3119",
    group: "Bristol",
    value: 37,
  },
  {
    label: "BRS-3134",
    group: "Bristol",
    value: 40,
  },
  {
    label: "BRS-3150",
    group: "Bristol",
    value: 43,
  },
  {
    label: "BRS-3166",
    group: "Bristol",
    value: 46,
  },
  {
    label: "BRS-3182",
    group: "Bristol",
    value: 49,
  },
  {
    label: "BRS-3198",
    group: "Bristol",
    value: 55,
  },
  {
    label: "LDS-4011",
    group: "Leeds",
    value: 32,
  },
  {
    label: "LDS-4028",
    group: "Leeds",
    value: 34,
  },
  {
    label: "LDS-4044",
    group: "Leeds",
    value: 36,
  },
  {
    label: "LDS-4061",
    group: "Leeds",
    value: 38,
  },
  {
    label: "LDS-4077",
    group: "Leeds",
    value: 39,
  },
  {
    label: "LDS-4093",
    group: "Leeds",
    value: 41,
  },
  {
    label: "LDS-4110",
    group: "Leeds",
    value: 44,
  },
  {
    label: "LDS-4126",
    group: "Leeds",
    value: 47,
  },
  {
    label: "LDS-4142",
    group: "Leeds",
    value: 50,
  },
  {
    label: "LDS-4159",
    group: "Leeds",
    value: 53,
  },
  {
    label: "LDS-4175",
    group: "Leeds",
    value: 56,
  },
  {
    label: "LDS-4191",
    group: "Leeds",
    value: 61,
  },
];
</script>
 
<template>
  <BeeswarmChart
    :points="orderDurations"
    aria-label="Order fulfilment times in minutes across London, Manchester, Bristol, and Leeds distribution centres, July 2026" />
</template>

import { ChangeDetectionStrategy, Component } from "@angular/core";
import { GrassrootBeeswarmChart } from "@grassroot/charts-angular";
 
@Component({
  selector: "app-beeswarm-chart-chart-demo",
  standalone: true,
  imports: [GrassrootBeeswarmChart],
  changeDetection: ChangeDetectionStrategy.OnPush,
  template: `<grassroot-beeswarm-chart
    [points]="orderDurations"
    ariaLabel="Order fulfilment times in minutes across London, Manchester, Bristol, and Leeds distribution centres, July 2026"
  />`,
})
export class BeeswarmChartDemoComponent {
  readonly orderDurations = [
    {
      label: "LON-1042",
      group: "London",
      value: 29,
    },
    {
      label: "LON-1057",
      group: "London",
      value: 31,
    },
    {
      label: "LON-1071",
      group: "London",
      value: 34,
    },
    {
      label: "LON-1086",
      group: "London",
      value: 36,
    },
    {
      label: "LON-1104",
      group: "London",
      value: 38,
    },
    {
      label: "LON-1122",
      group: "London",
      value: 39,
    },
    {
      label: "LON-1138",
      group: "London",
      value: 41,
    },
    {
      label: "LON-1154",
      group: "London",
      value: 43,
    },
    {
      label: "LON-1171",
      group: "London",
      value: 46,
    },
    {
      label: "LON-1188",
      group: "London",
      value: 49,
    },
    {
      label: "LON-1203",
      group: "London",
      value: 52,
    },
    {
      label: "LON-1220",
      group: "London",
      value: 58,
    },
    {
      label: "MAN-2031",
      group: "Manchester",
      value: 33,
    },
    {
      label: "MAN-2044",
      group: "Manchester",
      value: 35,
    },
    {
      label: "MAN-2062",
      group: "Manchester",
      value: 37,
    },
    {
      label: "MAN-2078",
      group: "Manchester",
      value: 38,
    },
    {
      label: "MAN-2093",
      group: "Manchester",
      value: 40,
    },
    {
      label: "MAN-2110",
      group: "Manchester",
      value: 42,
    },
    {
      label: "MAN-2126",
      group: "Manchester",
      value: 44,
    },
    {
      label: "MAN-2141",
      group: "Manchester",
      value: 47,
    },
    {
      label: "MAN-2158",
      group: "Manchester",
      value: 51,
    },
    {
      label: "MAN-2174",
      group: "Manchester",
      value: 54,
    },
    {
      label: "MAN-2190",
      group: "Manchester",
      value: 57,
    },
    {
      label: "MAN-2206",
      group: "Manchester",
      value: 63,
    },
    {
      label: "BRS-3018",
      group: "Bristol",
      value: 26,
    },
    {
      label: "BRS-3035",
      group: "Bristol",
      value: 28,
    },
    {
      label: "BRS-3051",
      group: "Bristol",
      value: 30,
    },
    {
      label: "BRS-3069",
      group: "Bristol",
      value: 32,
    },
    {
      label: "BRS-3088",
      group: "Bristol",
      value: 33,
    },
    {
      label: "BRS-3102",
      group: "Bristol",
      value: 35,
    },
    {
      label: "BRS-3119",
      group: "Bristol",
      value: 37,
    },
    {
      label: "BRS-3134",
      group: "Bristol",
      value: 40,
    },
    {
      label: "BRS-3150",
      group: "Bristol",
      value: 43,
    },
    {
      label: "BRS-3166",
      group: "Bristol",
      value: 46,
    },
    {
      label: "BRS-3182",
      group: "Bristol",
      value: 49,
    },
    {
      label: "BRS-3198",
      group: "Bristol",
      value: 55,
    },
    {
      label: "LDS-4011",
      group: "Leeds",
      value: 32,
    },
    {
      label: "LDS-4028",
      group: "Leeds",
      value: 34,
    },
    {
      label: "LDS-4044",
      group: "Leeds",
      value: 36,
    },
    {
      label: "LDS-4061",
      group: "Leeds",
      value: 38,
    },
    {
      label: "LDS-4077",
      group: "Leeds",
      value: 39,
    },
    {
      label: "LDS-4093",
      group: "Leeds",
      value: 41,
    },
    {
      label: "LDS-4110",
      group: "Leeds",
      value: 44,
    },
    {
      label: "LDS-4126",
      group: "Leeds",
      value: 47,
    },
    {
      label: "LDS-4142",
      group: "Leeds",
      value: 50,
    },
    {
      label: "LDS-4159",
      group: "Leeds",
      value: 53,
    },
    {
      label: "LDS-4175",
      group: "Leeds",
      value: 56,
    },
    {
      label: "LDS-4191",
      group: "Leeds",
      value: 61,
    },
  ];
}
 
export default BeeswarmChartDemoComponent;

<script lang="ts">
  import { BeeswarmChart } from "@grassroot/charts-svelte";
 
  const orderDurations = [
    {
      label: "LON-1042",
      group: "London",
      value: 29,
    },
    {
      label: "LON-1057",
      group: "London",
      value: 31,
    },
    {
      label: "LON-1071",
      group: "London",
      value: 34,
    },
    {
      label: "LON-1086",
      group: "London",
      value: 36,
    },
    {
      label: "LON-1104",
      group: "London",
      value: 38,
    },
    {
      label: "LON-1122",
      group: "London",
      value: 39,
    },
    {
      label: "LON-1138",
      group: "London",
      value: 41,
    },
    {
      label: "LON-1154",
      group: "London",
      value: 43,
    },
    {
      label: "LON-1171",
      group: "London",
      value: 46,
    },
    {
      label: "LON-1188",
      group: "London",
      value: 49,
    },
    {
      label: "LON-1203",
      group: "London",
      value: 52,
    },
    {
      label: "LON-1220",
      group: "London",
      value: 58,
    },
    {
      label: "MAN-2031",
      group: "Manchester",
      value: 33,
    },
    {
      label: "MAN-2044",
      group: "Manchester",
      value: 35,
    },
    {
      label: "MAN-2062",
      group: "Manchester",
      value: 37,
    },
    {
      label: "MAN-2078",
      group: "Manchester",
      value: 38,
    },
    {
      label: "MAN-2093",
      group: "Manchester",
      value: 40,
    },
    {
      label: "MAN-2110",
      group: "Manchester",
      value: 42,
    },
    {
      label: "MAN-2126",
      group: "Manchester",
      value: 44,
    },
    {
      label: "MAN-2141",
      group: "Manchester",
      value: 47,
    },
    {
      label: "MAN-2158",
      group: "Manchester",
      value: 51,
    },
    {
      label: "MAN-2174",
      group: "Manchester",
      value: 54,
    },
    {
      label: "MAN-2190",
      group: "Manchester",
      value: 57,
    },
    {
      label: "MAN-2206",
      group: "Manchester",
      value: 63,
    },
    {
      label: "BRS-3018",
      group: "Bristol",
      value: 26,
    },
    {
      label: "BRS-3035",
      group: "Bristol",
      value: 28,
    },
    {
      label: "BRS-3051",
      group: "Bristol",
      value: 30,
    },
    {
      label: "BRS-3069",
      group: "Bristol",
      value: 32,
    },
    {
      label: "BRS-3088",
      group: "Bristol",
      value: 33,
    },
    {
      label: "BRS-3102",
      group: "Bristol",
      value: 35,
    },
    {
      label: "BRS-3119",
      group: "Bristol",
      value: 37,
    },
    {
      label: "BRS-3134",
      group: "Bristol",
      value: 40,
    },
    {
      label: "BRS-3150",
      group: "Bristol",
      value: 43,
    },
    {
      label: "BRS-3166",
      group: "Bristol",
      value: 46,
    },
    {
      label: "BRS-3182",
      group: "Bristol",
      value: 49,
    },
    {
      label: "BRS-3198",
      group: "Bristol",
      value: 55,
    },
    {
      label: "LDS-4011",
      group: "Leeds",
      value: 32,
    },
    {
      label: "LDS-4028",
      group: "Leeds",
      value: 34,
    },
    {
      label: "LDS-4044",
      group: "Leeds",
      value: 36,
    },
    {
      label: "LDS-4061",
      group: "Leeds",
      value: 38,
    },
    {
      label: "LDS-4077",
      group: "Leeds",
      value: 39,
    },
    {
      label: "LDS-4093",
      group: "Leeds",
      value: 41,
    },
    {
      label: "LDS-4110",
      group: "Leeds",
      value: 44,
    },
    {
      label: "LDS-4126",
      group: "Leeds",
      value: 47,
    },
    {
      label: "LDS-4142",
      group: "Leeds",
      value: 50,
    },
    {
      label: "LDS-4159",
      group: "Leeds",
      value: 53,
    },
    {
      label: "LDS-4175",
      group: "Leeds",
      value: 56,
    },
    {
      label: "LDS-4191",
      group: "Leeds",
      value: 61,
    },
  ];
</script>
 
<BeeswarmChart
  points={orderDurations}
  ariaLabel="Order fulfilment times in minutes across London, Manchester, Bristol, and Leeds distribution centres, July 2026" />

/** @jsxImportSource solid-js */
import { BeeswarmChart } from "@grassroot/charts-solid";
 
const orderDurations = [
  {
    label: "LON-1042",
    group: "London",
    value: 29,
  },
  {
    label: "LON-1057",
    group: "London",
    value: 31,
  },
  {
    label: "LON-1071",
    group: "London",
    value: 34,
  },
  {
    label: "LON-1086",
    group: "London",
    value: 36,
  },
  {
    label: "LON-1104",
    group: "London",
    value: 38,
  },
  {
    label: "LON-1122",
    group: "London",
    value: 39,
  },
  {
    label: "LON-1138",
    group: "London",
    value: 41,
  },
  {
    label: "LON-1154",
    group: "London",
    value: 43,
  },
  {
    label: "LON-1171",
    group: "London",
    value: 46,
  },
  {
    label: "LON-1188",
    group: "London",
    value: 49,
  },
  {
    label: "LON-1203",
    group: "London",
    value: 52,
  },
  {
    label: "LON-1220",
    group: "London",
    value: 58,
  },
  {
    label: "MAN-2031",
    group: "Manchester",
    value: 33,
  },
  {
    label: "MAN-2044",
    group: "Manchester",
    value: 35,
  },
  {
    label: "MAN-2062",
    group: "Manchester",
    value: 37,
  },
  {
    label: "MAN-2078",
    group: "Manchester",
    value: 38,
  },
  {
    label: "MAN-2093",
    group: "Manchester",
    value: 40,
  },
  {
    label: "MAN-2110",
    group: "Manchester",
    value: 42,
  },
  {
    label: "MAN-2126",
    group: "Manchester",
    value: 44,
  },
  {
    label: "MAN-2141",
    group: "Manchester",
    value: 47,
  },
  {
    label: "MAN-2158",
    group: "Manchester",
    value: 51,
  },
  {
    label: "MAN-2174",
    group: "Manchester",
    value: 54,
  },
  {
    label: "MAN-2190",
    group: "Manchester",
    value: 57,
  },
  {
    label: "MAN-2206",
    group: "Manchester",
    value: 63,
  },
  {
    label: "BRS-3018",
    group: "Bristol",
    value: 26,
  },
  {
    label: "BRS-3035",
    group: "Bristol",
    value: 28,
  },
  {
    label: "BRS-3051",
    group: "Bristol",
    value: 30,
  },
  {
    label: "BRS-3069",
    group: "Bristol",
    value: 32,
  },
  {
    label: "BRS-3088",
    group: "Bristol",
    value: 33,
  },
  {
    label: "BRS-3102",
    group: "Bristol",
    value: 35,
  },
  {
    label: "BRS-3119",
    group: "Bristol",
    value: 37,
  },
  {
    label: "BRS-3134",
    group: "Bristol",
    value: 40,
  },
  {
    label: "BRS-3150",
    group: "Bristol",
    value: 43,
  },
  {
    label: "BRS-3166",
    group: "Bristol",
    value: 46,
  },
  {
    label: "BRS-3182",
    group: "Bristol",
    value: 49,
  },
  {
    label: "BRS-3198",
    group: "Bristol",
    value: 55,
  },
  {
    label: "LDS-4011",
    group: "Leeds",
    value: 32,
  },
  {
    label: "LDS-4028",
    group: "Leeds",
    value: 34,
  },
  {
    label: "LDS-4044",
    group: "Leeds",
    value: 36,
  },
  {
    label: "LDS-4061",
    group: "Leeds",
    value: 38,
  },
  {
    label: "LDS-4077",
    group: "Leeds",
    value: 39,
  },
  {
    label: "LDS-4093",
    group: "Leeds",
    value: 41,
  },
  {
    label: "LDS-4110",
    group: "Leeds",
    value: 44,
  },
  {
    label: "LDS-4126",
    group: "Leeds",
    value: 47,
  },
  {
    label: "LDS-4142",
    group: "Leeds",
    value: 50,
  },
  {
    label: "LDS-4159",
    group: "Leeds",
    value: 53,
  },
  {
    label: "LDS-4175",
    group: "Leeds",
    value: 56,
  },
  {
    label: "LDS-4191",
    group: "Leeds",
    value: 61,
  },
];
 
export default function BeeswarmChartDemo() {
  return (
    <BeeswarmChart
      points={orderDurations}
      ariaLabel="Order fulfilment times in minutes across London, Manchester, Bristol, and Leeds distribution centres, July 2026" />
  );
}

Installation

API Reference

Import

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

Props

Prop

Type

Default

Requirement

Description

points

readonly PointDistributionDatum[]

—

required

—

brushDomain

ChartXDomain | undefined

—

optional

—

defaultBrushDomain

ChartXDomain | undefined

—

optional

—

onBrushDomainChange

((domain: ChartXDomain) => void) | undefined

—

optional

—

zoomDomain

ChartXDomain | undefined

—

optional

—

defaultZoomDomain

ChartXDomain | undefined

—

optional

—

onZoomDomainChange

((domain: ChartXDomain) => void) | undefined

—

optional

—

zoomOnBrush

boolean | undefined

—

optional

—

formatXValue

((value: number, index: number) => string) | undefined

—

optional

—

formatYValue

((value: number, index: number) => string) | undefined

—

optional

—

locale

string | readonly string[] | undefined

—

optional

—

legend

boolean | import("@grassroot/chart-spec").LegendConfig | undefined

—

optional

—

animation

boolean | import("./base").ExpandedChartAnimationConfig | undefined

—

optional

—

Prop: points
Type: readonly PointDistributionDatum[]
Default: —
Requirement: required
Description: —

Prop: brushDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional
Description: —

Prop: defaultBrushDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional
Description: —

Prop: onBrushDomainChange
Type: ((domain: ChartXDomain) => void) | undefined
Default: —
Requirement: optional
Description: —

Prop: zoomDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional
Description: —

Prop: defaultZoomDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional
Description: —

Prop: onZoomDomainChange
Type: ((domain: ChartXDomain) => void) | undefined
Default: —
Requirement: optional
Description: —

Prop: zoomOnBrush
Type: boolean | undefined
Default: —
Requirement: optional
Description: —

Prop: formatXValue
Type: ((value: number, index: number) => string) | undefined
Default: —
Requirement: optional
Description: —

Prop: formatYValue
Type: ((value: number, index: number) => string) | undefined
Default: —
Requirement: optional
Description: —

Prop: locale
Type: string | readonly string[] | 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

Event	Payload
`onBrushDomainChange`	`((domain: ChartXDomain) => void) \| undefined`
`onZoomDomainChange`	`((domain: ChartXDomain) => void) \| undefined`
`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 { BeeswarmChart } 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

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: points
Type: readonly PointDistributionDatum[]
Default: —
Requirement: required

Prop: formatXValue
Type: ((value: number, index: number) => string) | undefined
Default: —
Requirement: optional

Prop: formatYValue
Type: ((value: number, index: number) => string) | undefined
Default: —
Requirement: optional

Prop: locale
Type: string | readonly string[] | undefined
Default: —
Requirement: optional

Prop: brushDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional

Prop: defaultBrushDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional

Prop: zoomDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional

Prop: defaultZoomDomain
Type: ChartXDomain | undefined
Default: —
Requirement: optional

Prop: zoomOnBrush
Type: boolean | undefined
Default: false
Requirement: optional

Events

Event	Payload
`hiddenSeriesChange`	`[ids: readonly string[]]`
`activeDatumChange`	`[id: string \| null]`
`brushDomainChange`	`[domain: ChartXDomain]`
`zoomDomainChange`	`[domain: ChartXDomain]`

Content regions

dataSummary
default

Import

import { ChangeDetectionStrategy, Component } from "@angular/core";
import { GrassrootBeeswarmChart } 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

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: brushDomain
Type: ChartXDomain
Default: —
Requirement: optional

Prop: defaultBrushDomain
Type: ChartXDomain
Default: —
Requirement: optional

Prop: zoomDomain
Type: ChartXDomain
Default: —
Requirement: optional

Prop: defaultZoomDomain
Type: ChartXDomain
Default: null
Requirement: optional

Prop: zoomOnBrush
Type: boolean
Default: false
Requirement: optional

Prop: points
Type: readonly PointDistributionDatum[]
Default: —
Requirement: required

Prop: width
Type: number
Default: —
Requirement: optional

Prop: height
Type: number
Default: —
Requirement: optional

Prop: showGrid
Type: boolean
Default: —
Requirement: optional

Prop: formatXValue
Type: PointDistributionChartOptions["formatXValue"]
Default: —
Requirement: optional

Prop: formatYValue
Type: PointDistributionChartOptions["formatYValue"]
Default: —
Requirement: optional

Prop: locale
Type: PointDistributionChartOptions["locale"]
Default: —
Requirement: optional

Prop: className
Type: string
Default: —
Requirement: optional

Events

Event	Payload
`activeDatumChange`	`string \| null`
`hiddenSeriesChange`	`readonly string[]`
`brushDomainChange`	`ChartXDomain`
`zoomDomainChange`	`ChartXDomain`

Content regions

dataSummary
default

Import

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

Props

Prop

Type

Default

Requirement

points

readonly PointDistributionDatum[]

—

required

formatXValue

PointDistributionChartOptions["formatXValue"]

—

optional

formatYValue

PointDistributionChartOptions["formatYValue"]

—

optional

locale

PointDistributionChartOptions["locale"]

—

optional

brushDomain

{ readonly start: number; readonly end: number } | null

—

optional

defaultBrushDomain

{ readonly start: number; readonly end: number } | null

—

optional

onBrushDomainChange

(domain: { readonly start: number; readonly end: number } | null) => void

—

optional

zoomDomain

{ readonly start: number; readonly end: number } | null

—

optional

defaultZoomDomain

{ readonly start: number; readonly end: number } | null

null

optional

onZoomDomainChange

(domain: { readonly start: number; readonly end: number } | null) => void

—

optional

zoomOnBrush

boolean

false

optional

onHiddenSeriesChange

(ids: readonly string[]) => void

—

optional

onActiveDatumChange

(id: string | null) => void

—

optional

class

string

—

optional

Prop: points
Type: readonly PointDistributionDatum[]
Default: —
Requirement: required

Prop: formatXValue
Type: PointDistributionChartOptions["formatXValue"]
Default: —
Requirement: optional

Prop: formatYValue
Type: PointDistributionChartOptions["formatYValue"]
Default: —
Requirement: optional

Prop: locale
Type: PointDistributionChartOptions["locale"]
Default: —
Requirement: optional

Prop: brushDomain
Type: { readonly start: number; readonly end: number } | null
Default: —
Requirement: optional

Prop: defaultBrushDomain
Type: { readonly start: number; readonly end: number } | null
Default: —
Requirement: optional

Prop: onBrushDomainChange
Type: (domain: { readonly start: number; readonly end: number } | null) => void
Default: —
Requirement: optional

Prop: zoomDomain
Type: { readonly start: number; readonly end: number } | null
Default: —
Requirement: optional

Prop: defaultZoomDomain
Type: { readonly start: number; readonly end: number } | null
Default: null
Requirement: optional

Prop: onZoomDomainChange
Type: (domain: { readonly start: number; readonly end: number } | null) => void
Default: —
Requirement: optional

Prop: zoomOnBrush
Type: boolean
Default: false
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

Event	Payload
`onBrushDomainChange`	`(domain: { readonly start: number; readonly end: number } \| null) => void`
`onZoomDomainChange`	`(domain: { readonly start: number; readonly end: number } \| null) => void`
`onHiddenSeriesChange`	`(ids: readonly string[]) => void`
`onActiveDatumChange`	`(id: string \| null) => void`

Content regions

children
dataSummary

Import

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

Props

Prop

Type

Default

Requirement

points

readonly PointDistributionDatum[]

—

required

formatXValue

(value: number, index: number) => string

—

optional

formatYValue

(value: number, index: number) => string

—

optional

locale

string | readonly string[]

—

optional

brushDomain

ChartXDomain

—

optional

defaultBrushDomain

ChartXDomain

—

optional

onBrushDomainChange

(domain: ChartXDomain) => void

—

optional

zoomDomain

ChartXDomain

—

optional

defaultZoomDomain

ChartXDomain

—

optional

onZoomDomainChange

(domain: ChartXDomain) => void

—

optional

zoomOnBrush

boolean

—

optional

onActiveDatumChange

(id: string | null) => void

—

optional

onHiddenSeriesChange

(ids: readonly string[]) => void

—

optional

class

string

—

optional

Prop: points
Type: readonly PointDistributionDatum[]
Default: —
Requirement: required

Prop: formatXValue
Type: (value: number, index: number) => string
Default: —
Requirement: optional

Prop: formatYValue
Type: (value: number, index: number) => string
Default: —
Requirement: optional

Prop: locale
Type: string | readonly string[]
Default: —
Requirement: optional

Prop: brushDomain
Type: ChartXDomain
Default: —
Requirement: optional

Prop: defaultBrushDomain
Type: ChartXDomain
Default: —
Requirement: optional

Prop: onBrushDomainChange
Type: (domain: ChartXDomain) => void
Default: —
Requirement: optional

Prop: zoomDomain
Type: ChartXDomain
Default: —
Requirement: optional

Prop: defaultZoomDomain
Type: ChartXDomain
Default: —
Requirement: optional

Prop: onZoomDomainChange
Type: (domain: ChartXDomain) => void
Default: —
Requirement: optional

Prop: zoomOnBrush
Type: boolean
Default: —
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: —
Requirement: optional

Prop: rendererStrategy
Type: Partial<ChartRendererStrategy>
Default: —
Requirement: optional

Prop: renderPlanMode
Type: "svg" | "host"
Default: —
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

Event	Payload
`onBrushDomainChange`	`(domain: ChartXDomain) => void`
`onZoomDomainChange`	`(domain: ChartXDomain) => void`
`onActiveDatumChange`	`(id: string \| null) => void`
`onHiddenSeriesChange`	`(ids: readonly string[]) => void`

Content regions

children
dataSummary