# Bar chart

Compare one or more measures across the values of a dimension.

- Component: `<BarChart />`, imported from `em-kit`
- Required props: `dimension`, `measures` and `results`
- HTML page, with live previews: https://emkit.embeddable.com/docs/components/bar-chart
- Playground (needs a browser): https://emkit.embeddable.com/docs/components/bar-chart/playground

`BarChart` takes `dimension` + `measures`. Its siblings name their fields differently: `BarChartStacked` and `BarChartGrouped` take `xAxis` + `groupBy` + `measure`; `BarChartStackedHorizontal` and `BarChartGroupedHorizontal` take `yAxis` + `groupBy` + `measure`.

## Install

```bash
npm install em-kit
pnpm add em-kit   # or, with pnpm
yarn add em-kit   # or, with yarn
bun add em-kit   # or, with bun
```

`react` and `react-dom` 19.1.1 or later are the only peer dependencies; Chart.js installs with the package. Wrap your app, or the part with charts, in `<ChartsProvider>` once: without it every chart throws `EmKit components must be rendered inside <ChartsProvider>.` Every example on this page includes `<ChartsProvider>` so that it runs on its own: if your app already has one, delete it from the example. A chart fills its parent, so the parent needs a height. In the Next.js App Router, every file that renders `ChartsProvider` or a chart starts with `'use client'`, and the provider pins the locale, `theme={{ formatter: { locale: 'en-US' } }}`, so the server and the browser format numbers alike. [The quick start](/docs/quick-start.md#in-the-nextjs-app-router) has the Next.js files.

## Usage

```tsx
import { ChartsProvider, BarChart, dimension, measure, results } from 'em-kit';

const industry = dimension({ name: 'industry', title: 'Industry' });
const customers = measure({
  name: 'customers',
  title: 'Customers',
  inputs: { abbreviateLargeNumber: true },
});

export const Example = () => (
  <ChartsProvider>
    <div style={{ height: 360 }}>
      <BarChart
        title="Customers by industry"
        dimension={industry}
        measures={[customers]}
        results={results(rows)}
      />
    </div>
  </ChartsProvider>
);

const rows = [
  { industry: 'Health', customers: 448 },
  { industry: 'Media', customers: 677 },
  { industry: 'Retail', customers: 741 },
  { industry: 'Tech', customers: 707 },
];
```

- Each row in `results` is one bar: the dimension's value plus each measure.
- Format values through the measure's `inputs`: here `abbreviateLargeNumber` shortens thousands to K.

## States

The chart draws its own states from `results`: a skeleton while `isLoading` is true and it has no rows, a spinner in the header while it reloads rows it already has, an empty state when `data` is `[]`, and the message when `error` is set. Pass your query’s state straight through.

## Examples

### Monthly columns

Six months as columns, each labelled with its abbreviated value. A time dimension with `granularity: 'month'` labels the axis and fills months with no row.

```tsx
import { ChartsProvider, BarChart, dimension, measure, results } from 'em-kit';

const startDate = dimension({
  name: 'startDate',
  title: 'Start date',
  type: 'time',
  granularity: 'month',
});
const revenue = measure({
  name: 'revenue',
  title: 'Revenue',
  inputs: { currency: 'USD', abbreviateLargeNumber: true },
});

export const Example = () => (
  <ChartsProvider>
    <div style={{ height: 360 }}>
      <BarChart
        title="Revenue by month"
        dimension={startDate}
        measures={[revenue]}
        results={results(rows)}
      />
    </div>
  </ChartsProvider>
);

const rows = [
  { startDate: '2026-01-01T00:00:00.000', revenue: 131229 },
  { startDate: '2026-02-01T00:00:00.000', revenue: 116685 },
  { startDate: '2026-03-01T00:00:00.000', revenue: 141619 },
  { startDate: '2026-04-01T00:00:00.000', revenue: 138438 },
  { startDate: '2026-05-01T00:00:00.000', revenue: 148882 },
  { startDate: '2026-06-01T00:00:00.000', revenue: 160625 },
];
```

### Growth, up and down

Month-on-month change as a percentage, with bars below zero for the months that fell. Compute `growth` in your query and describe it with its own `measure()`, formatted by `suffix` and `decimalPlaces`.

```tsx
import { ChartsProvider, BarChart, dimension, measure, results } from 'em-kit';

const startDate = dimension({
  name: 'startDate',
  title: 'Start date',
  type: 'time',
  granularity: 'month',
});
const growth = measure({
  name: 'growth',
  title: 'Revenue growth',
  inputs: { suffix: '%', decimalPlaces: 1 },
});

export const Example = () => (
  <ChartsProvider>
    <div style={{ height: 360 }}>
      <BarChart
        title="Revenue growth, month on month"
        dimension={startDate}
        measures={[growth]}
        results={results(rows)}
      />
    </div>
  </ChartsProvider>
);

const rows = [
  { startDate: '2026-01-01T00:00:00.000', growth: 0.6 },
  { startDate: '2026-02-01T00:00:00.000', growth: -11.1 },
  { startDate: '2026-03-01T00:00:00.000', growth: 21.4 },
  { startDate: '2026-04-01T00:00:00.000', growth: -2.2 },
  { startDate: '2026-05-01T00:00:00.000', growth: 7.5 },
  { startDate: '2026-06-01T00:00:00.000', growth: 7.9 },
];
```

### Axis titles

A caption on each axis, for a chart that has to stand on its own in a report.

```tsx
import { ChartsProvider, BarChart, dimension, measure, results } from 'em-kit';

const industry = dimension({ name: 'industry', title: 'Industry' });
const customers = measure({
  name: 'customers',
  title: 'Customers',
  inputs: { abbreviateLargeNumber: true },
});

export const Example = () => (
  <ChartsProvider>
    <div style={{ height: 360 }}>
      <BarChart
        title="Customers by industry"
        dimension={industry}
        measures={[customers]}
        results={results(rows)}
        showValueLabels={false}
        xAxisLabel="Industry"
        yAxisLabel="Customers"
      />
    </div>
  </ChartsProvider>
);

const rows = [
  { industry: 'Health', customers: 448 },
  { industry: 'Media', customers: 677 },
  { industry: 'Retail', customers: 741 },
  { industry: 'Tech', customers: 707 },
];
```

### Fixed value range

A pinned value axis, so charts side by side share one scale. `yAxisRangeMin` and `yAxisRangeMax` pin the axis; values above the maximum are clipped.

```tsx
import { ChartsProvider, BarChart, dimension, measure, results } from 'em-kit';

const industry = dimension({ name: 'industry', title: 'Industry' });
const customers = measure({
  name: 'customers',
  title: 'Customers',
  inputs: { abbreviateLargeNumber: true },
});

export const Example = () => (
  <ChartsProvider>
    <div style={{ height: 360 }}>
      <BarChart
        title="Customers by industry"
        dimension={industry}
        measures={[customers]}
        results={results(rows)}
        yAxisRangeMin={0}
        yAxisRangeMax={2000}
      />
    </div>
  </ChartsProvider>
);

const rows = [
  { industry: 'Health', customers: 448 },
  { industry: 'Media', customers: 677 },
  { industry: 'Retail', customers: 741 },
  { industry: 'Tech', customers: 707 },
];
```

### Long tail as “Other”

Rows sorted largest first: the top five as bars, and the rest added up into one “Other” bar. `xAxisMaxItems: 6` keeps the first five rows in your order and adds up the rest, so sort the query largest first.

```tsx
import { ChartsProvider, BarChart, dimension, measure, results } from 'em-kit';

const account = dimension({ name: 'account', title: 'Account' });
const revenue = measure({
  name: 'revenue',
  title: 'Revenue',
  inputs: { currency: 'USD', abbreviateLargeNumber: true },
});

export const Example = () => (
  <ChartsProvider>
    <div style={{ height: 360 }}>
      <BarChart
        title="Revenue by account"
        dimension={account}
        measures={[revenue]}
        results={results(rows)}
        xAxisMaxItems={6}
      />
    </div>
  </ChartsProvider>
);

const rows = [
  { account: 'Juniper', revenue: 176000 },
  { account: 'Kite', revenue: 152000 },
  { account: 'Harbor', revenue: 131000 },
  { account: 'Isle', revenue: 114000 },
  { account: 'Fjord', revenue: 96000 },
  { account: 'Grove', revenue: 84000 },
  { account: 'Dune', revenue: 78000 },
  { account: 'Ember', revenue: 64000 },
  { account: 'Birch', revenue: 60000 },
  { account: 'Cedar', revenue: 49000 },
  { account: 'Alder', revenue: 44000 },
];
```

## Props

Required props come first. A blank default means the prop is unset unless you pass it.

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `dimension` | `Dimension` | yes |  | The field whose values label the axis or the segments. Its `name` is the row key. |
| `measures` | `Measure[]` | yes |  | The numeric fields to plot, one series each. Their `inputs` set the formatting. |
| `results` | `DataResponse` | yes |  | Your query’s state: `{ isLoading, data, error }`, where `data` is your rows. `results(rows)` builds it from an array. |
| `showLegend` | `boolean` | no | `true` | Show the legend. A chart with one series shows none; entries wrap onto more lines when they do not fit. |
| `showLogarithmicScale` | `boolean` | no | `false` | Use a logarithmic value axis, for values that span several orders of magnitude. |
| `showTooltips` | `boolean` | no | `true` | Show a formatted tooltip on hover. |
| `showValueLabels` | `boolean` | no | `true` | Print each value on the chart. |
| `xAxisLabel` | `string` | no |  | A title under the x-axis. |
| `yAxisLabel` | `string` | no |  | A title beside the y-axis. |
| `granularity` | `Granularity` | no |  | Only sets the size of the date range a click reports (`dimensionTimeRange`). The axis labels and the gap filling come from the time field, `dimension({ granularity })`, and this prop follows the field when left out. One of `"second"`, `"minute"`, `"hour"`, `"day"`, `"week"`, `"month"`, `"quarter"`, `"year"`. |
| `setGranularity` | `(granularity: Granularity) => void` | no |  | Called with the granularity the reader picks in the card. The picker only shows when the time field sets `showGranularityDropdown: true` in its `inputs`. Store the value, set it as the field’s `granularity` and pass rows at that granularity. |
| `onBarClicked` | `(args: BarChartOptionsClickArg) => void` | no |  | Called with the clicked bar’s dimension value and, on a time axis, its date range. Use it as a filter. |
| `componentName` | `string` | no |  | A name for this component, included in the interaction events it dispatches on the DOM, for your analytics. |
| `trackingId` | `string` | no |  | An id included in the same events, to tell two instances apart. |
| `title` | `string` | no |  | The card’s title. A `"key\|fallback"` string is looked up in your translations. |
| `description` | `string` | no |  | Smaller text under the title. Translates like `title`. |
| `tooltip` | `string` | no |  | Text for an info icon beside the title. |
| `hideMenu` | `boolean` | no | `false` | Hide the card’s header: the title, description and menu. |
| `menuOptions` | `("csv" \| "xlsx" \| "png" \| "maximize")[]` | no | `["csv", "xlsx", "png", "maximize"]` | Which entries the card menu offers. Pass `[]` for none. |
| `reverseXAxis` | `boolean` | no | `false` | Reverse the order of the x-axis. |
| `xAxisMaxItems` | `number` | no |  | Show at most this many x values. The rest are added up into one “Other” value. |
| `yAxisRangeMin` | `number` | no |  | Fix the lowest value on the y-axis. When unset, a bar, line or area chart’s axis includes zero, and a scatter or bubble chart’s fits the data. |
| `yAxisRangeMax` | `number` | no |  | Fix the highest value on the y-axis. When unset, it fits the data. |

```ts
type BarChartOptionsClickArg = { dimensionValue: string | number | undefined; dimensionTimeRange: TimeRange; measureValues?: Record<string, unknown> | undefined; }
type Granularity = "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year"
type TimeRange = { from: Date | undefined; to: Date | undefined; relativeTimeString?: string; } | undefined
```

Each is exported from `em-kit` as a type, for example `import type { BarChartOptionsClickArg } from 'em-kit'`.

A click payload’s `TimeRange` is `undefined` unless the clicked field is a time dimension, and its `relativeTimeString` is always `undefined`, so read it as `range?.from`. When you pass one, `from` and `to` are enough.

## Field options

Options go in a field’s `inputs`, for example `measure({ name: 'revenue', inputs: { prefix: '$' } })`. Every field takes `prefix`, `suffix`, `decimalPlaces`, `currency`, `abbreviateLargeNumber`, `displayName` and `maxCharacters`. A time dimension in `dimension` also takes `granularity`, `showGranularityDropdown`, `dateBounds` and `ignoreEmptyDate`. Its `granularity` is what labels the axis as dates and fills periods with no row; `dimension()` takes it in `inputs` or at the top level, `dimension({ granularity: 'month' })`. [Field options](/docs/describing-your-data.md#field-options) describes them. `BarChart` also reads:

| Option | Type | Set on | Default | Description |
|---|---|---|---|---|
| `color` | `string` | `measures` |  | A colour for this measure’s bars, in place of the theme’s. |
| `showValueAsPercentage` | `boolean` | `measures` | `false` | Label each value with its share of the total. The tooltip shows both. |
