# Stacked area chart

Stacked areas showing how segments contribute to a total over time.

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

`AreaChart` takes `xAxis` + `groupBy` + `measure`. Its siblings name their fields differently: `LineChart`, `LineChartComparison`, `LineChartWithKpiTabs` and `LineChartComparisonWithKpiTabs` take `xAxis` + `measures`.

## 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, AreaChart, dimension, measure, results } from 'em-kit';

const startDate = dimension({
  name: 'startDate',
  title: 'Start date',
  type: 'time',
  granularity: 'month',
});
const plan = dimension({ name: 'plan', title: 'Plan' });
const customers = measure({
  name: 'customers',
  title: 'Customers',
  inputs: { abbreviateLargeNumber: true },
});

export const Example = () => (
  <ChartsProvider>
    <div style={{ height: 360 }}>
      <AreaChart
        title="Customers by plan over time"
        xAxis={startDate}
        groupBy={plan}
        measure={customers}
        results={results(rows)}
        showValueLabels={false}
      />
    </div>
  </ChartsProvider>
);

const rows = [
  { startDate: '2026-03-01T00:00:00.000', plan: 'Starter', customers: 236 },
  { startDate: '2026-03-01T00:00:00.000', plan: 'Growth', customers: 202 },
  { startDate: '2026-03-01T00:00:00.000', plan: 'Enterprise', customers: 31 },
  { startDate: '2026-04-01T00:00:00.000', plan: 'Starter', customers: 211 },
  { startDate: '2026-04-01T00:00:00.000', plan: 'Growth', customers: 168 },
  { startDate: '2026-04-01T00:00:00.000', plan: 'Enterprise', customers: 32 },
  { startDate: '2026-05-01T00:00:00.000', plan: 'Starter', customers: 212 },
  { startDate: '2026-05-01T00:00:00.000', plan: 'Growth', customers: 177 },
  { startDate: '2026-05-01T00:00:00.000', plan: 'Enterprise', customers: 39 },
  { startDate: '2026-06-01T00:00:00.000', plan: 'Starter', customers: 205 },
  { startDate: '2026-06-01T00:00:00.000', plan: 'Growth', customers: 220 },
  { startDate: '2026-06-01T00:00:00.000', plan: 'Enterprise', customers: 52 },
];
```

## 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

### Axis titles

A caption on each axis.

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

const startDate = dimension({
  name: 'startDate',
  title: 'Start date',
  type: 'time',
  granularity: 'month',
});
const plan = dimension({ name: 'plan', title: 'Plan' });
const customers = measure({
  name: 'customers',
  title: 'Customers',
  inputs: { abbreviateLargeNumber: true },
});

export const Example = () => (
  <ChartsProvider>
    <div style={{ height: 360 }}>
      <AreaChart
        title="Customers by plan over time"
        xAxis={startDate}
        groupBy={plan}
        measure={customers}
        results={results(rows)}
        showValueLabels={false}
        xAxisLabel="Start date"
        yAxisLabel="Customers"
      />
    </div>
  </ChartsProvider>
);

const rows = [
  { startDate: '2026-03-01T00:00:00.000', plan: 'Starter', customers: 236 },
  { startDate: '2026-03-01T00:00:00.000', plan: 'Growth', customers: 202 },
  { startDate: '2026-03-01T00:00:00.000', plan: 'Enterprise', customers: 31 },
  { startDate: '2026-04-01T00:00:00.000', plan: 'Starter', customers: 211 },
  { startDate: '2026-04-01T00:00:00.000', plan: 'Growth', customers: 168 },
  { startDate: '2026-04-01T00:00:00.000', plan: 'Enterprise', customers: 32 },
  { startDate: '2026-05-01T00:00:00.000', plan: 'Starter', customers: 212 },
  { startDate: '2026-05-01T00:00:00.000', plan: 'Growth', customers: 177 },
  { startDate: '2026-05-01T00:00:00.000', plan: 'Enterprise', customers: 39 },
  { startDate: '2026-06-01T00:00:00.000', plan: 'Starter', customers: 205 },
  { startDate: '2026-06-01T00:00:00.000', plan: 'Growth', customers: 220 },
  { startDate: '2026-06-01T00:00:00.000', plan: 'Enterprise', customers: 52 },
];
```

## Props

Required props come first. A blank default means the prop is unset unless you pass it. Not listed: `resultsGroupOrder`, `resultsGroupOther`, `groupOrderCacheKey`, `setGroupOrderAndCacheKey` and `xAxisMaxItems`, which the type accepts and the component does not read.

| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `xAxis` | `Dimension` | yes |  | The dimension along the x-axis. A time dimension gets gap filling and date labels. |
| `groupBy` | `Dimension` | yes |  | A second dimension that splits each axis value into one series per value. |
| `measure` | `Measure` | yes |  | The numeric field to plot. Its `inputs` (`prefix`, `suffix`, `decimalPlaces`) 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. |
| `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. |
| `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. |
| `yAxisRangeMax` | `number` | no |  | Fix the highest value on the y-axis. When unset, it fits the data. |
| `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. |
| `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. |
| `onPointClicked` | `(arg: AreaChartPointClickArg) => void` | no |  | Called with the clicked point’s dimension value, date range and measure value. |
| `onAreaClicked` | `(arg: AreaChartAreaClickArg) => void` | no |  | Called with the clicked area’s `groupBy` value. |

```ts
type AreaChartPointClickArg = { dimensionValue: string | number | undefined; dimensionTimeRange: TimeRange; measureValue: number | undefined; }
type AreaChartAreaClickArg = { groupingDimensionValue: string | boolean | undefined; groupingDimensionTimeRange: TimeRange; }
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 { AreaChartPointClickArg } 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 `xAxis` 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. `AreaChart` also reads:

| Option | Type | Set on | Default | Description |
|---|---|---|---|---|
| `connectGaps` | `boolean` | `measure` | `false` | Draw a missing value as zero, so the line carries on. When off, the line breaks at the gap. |
