# Threshold sweep

> Alerts per week at every threshold. Sample data: alerts per week from 93% to 97%, 14 at 96% now, 3 at a proposed 95%.

- Type 112 · Relationship
- Component: `<ThresholdSweep>`, the same name as the Figma component
- Install: `npx shadcn add @chartory/threshold-sweep` (Code and Complete plans)
- Type page: https://usechartory.com/charts/threshold-sweep

## Installation

1. **Set up the registry once.** Your token in .env and @chartory in components.json. Skip this when another chart is already installed. [Installation guide](https://usechartory.com/docs/installation)

2. **Add the chart.** One command adds the Threshold sweep component to your project.

```bash
npx shadcn add @chartory/threshold-sweep
```

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

usage.tsx:

```tsx
import { ThresholdSweep }
  from "@/components/chartory/threshold-sweep"

<ThresholdSweep
  data={alertSweep}
  size="m"
  legend
/>
```

## Props

### `<ThresholdSweep>`

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

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| data | ThresholdSweepData | 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. |
| legend | boolean | true | Shows the legend row under the plot. |

### ThresholdSweepData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| steps | [number, number][] | Required | One entry per step. |
| xmin | number | Required | The left end of the x scale. |
| xmax | number | Required | The right end of the x scale. |
| ymax | number | Required | The top of the y scale. |
| xt | [number, string][] | Required | The x axis ticks: [value, label] pairs. |
| yt | [number, string][] | Required | The y axis ticks: [value, label] pairs. |
| now | ThresholdSweepNow | Required | Now: where it is and its label. |
| prop | ThresholdSweepProp | Required | The proposed value and its label. |

### ThresholdSweepNow

The now object.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| x | number | Required | The x value. |
| y | number | Required | The y value. |
| text | string | Required | The label as shown. |

### ThresholdSweepProp

The prop object.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| x | number | Required | The x value. |
| y | number | Required | The y value. |
| text | string | Required | The label as shown. |

## Threshold sweep: a React and Figma chart in four sizes

### What does a threshold sweep show?

A threshold sweep draws how many alerts a rule would fire at each threshold, with the current and proposed settings marked. You pick the threshold by its cost in alerts. Use it for alert tuning and SLO targets.

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 Threshold sweep component?

It is one **<ThresholdSweep>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is alerts per threshold.

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?

- **Is the whole range shown?** Yes means the threshold sweep fits.
- **Is it alerts per threshold?** Yes means the threshold sweep fits.
- **Is it a curve?** Yes means the threshold sweep fits.

### When does another type fit better?

- **Two thresholds over time.** Use Threshold what-if instead.
- **A measure against a target.** Use Target trend instead.
- **Rule by rule over a week.** Use Alert fire strip instead.

## Threshold sweep questions

### Does the Threshold sweep 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?

Add your token and the @chartory registry once, then run npx shadcn add @chartory/threshold-sweep. The Installation guide has the steps.

### Can my coding agent install it?

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

### What data does it expect?

Alerts per threshold. 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/112-threshold-sweep 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?

Code and Complete. Figma has the Figma file only.