# Cluster map

> Similar items grouped into named clusters. Sample data: support tickets in five clusters, billing, login and SSO, integrations, bugs and feature asks.

- Type 091 · Relationship
- Component: `<ClusterMap>`, the same name as the Figma component
- Install: `npx shadcn add @chartory/cluster-map` (free in Hearth: the public registry, no token; Signal with Code and Complete)
- Type page: https://usechartory.com/charts/cluster-map

## Installation

1. **Set up the registry once.** This chart is free in Hearth and MIT licensed: no token. Add @chartory to components.json once (the URL alone, no headers), or skip this when another chart is already installed. [Installation guide](https://usechartory.com/docs/installation)

2. **Add the chart.** One command adds the Cluster map component to your project.

```bash
npx shadcn add @chartory/cluster-map
```

3. **Use it.** Pass your rows. The props are the Figma properties.

usage.tsx:

```tsx
import { ClusterMap }
  from "@/components/chartory/cluster-map"

<ClusterMap
  data={ticketClusters}
  size="m"
/>
```

## Props

### `<ClusterMap>`

Every prop but data is a Figma property with the same name and values.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| data | ClusterMapData | Required | The chart's data. The tables below list every field. |
| size | "xs" \| "s" \| "m" \| "l" | "m" | The size class. Each one is laid out again from the data. |
| color | "cat-1" \| "cat-2" \| "cat-3" \| "cat-4" | "cat-1" | The data colour of the primary marks (data/primary). |

### ClusterMapData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| seed? | number | 9 | Seeds the generated marks, so the layout is the same on every render. |
| clusters | ClusterMapCluster[] | Required | One entry per cluster. |

### ClusterMapCluster

One object per entry in clusters.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| label | string | Required | The name shown on the chart. |
| tok | string | Required | The colour token, e.g. "data/primary". |
| cx | number | Required | The cluster's centre, x. |
| cy | number | Required | The cluster's centre, y. |
| sx | number | Required | The cluster's spread, x. |
| sy | number | Required | The cluster's spread, y. |
| n | number | Required | The number of points in the cluster. |

## Cluster map: a React and Figma chart in four sizes

### What does a cluster map show?

A cluster map places items by how similar they are, so they gather into groups, then names each group. Big and small clusters stand out. Use it for support tickets, feedback or search queries.

Chartory ships it as a Figma component and a React component with the same name. The code installs from the shadcn registry with one command and lands in your project as a file you own.

### What is the Cluster map component?

It is one **<ClusterMap>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is a centre, a spread and a count per cluster; the points are generated from them.

Sizes **XS**, **S**, **M** and **L** re-lay the chart out from the data instead of scaling it, so labels stay readable at every size.

### When should I use it?

- **Are the groups found from the data?** Yes means the cluster map fits.
- **Is it items, not words?** Yes means the cluster map fits.
- **Is position by similarity?** Yes means the cluster map fits.

### When does another type fit better?

- **Groups you already know.** Use Treemap instead.
- **Words sized by count.** Use Term cloud instead.
- **Two measures per item.** Use Scatter instead.

## Cluster map questions

### Does the Cluster map chart work with shadcn/ui?

Yes. It installs through the shadcn registry with the shadcn CLI, and the file lands in your project.

### How do I install it?

It is free in Hearth and MIT licensed: add the @chartory registry URL once, no token, then run npx shadcn add @chartory/cluster-map. The Installation guide has the steps.

### Can my coding agent install it?

Yes. Connect the Chartory MCP server and ask for the cluster map chart; the agent runs the same command and you review the diff.

### What data does it expect?

A centre, a spread and a count per cluster; the points are generated from them. The sample data comes with the component, and the props table lists every field.

### Which sizes does it ship in?

XS, S, M and L, in Figma and in code. Each size is laid out again from the data, so text and lines keep their size.

### Is it in the Figma file too?

Yes. chart/091-clusters-tickets has the same properties as the component.

### Does it follow light and dark mode?

Yes. Every paint is a token, so the chart follows light and dark mode and the collection you pick.

### Which plan has the code?

None for Hearth: it is free in the public registry, no token. The Signal collection (@chartory/signal) comes with Code and Complete.