---
title: "Series Labels"
framework: react
version: "14.1.0"
---

# Series Labels

Series data labels display the value of a data point directly on the chart. These are configured on the `label` property of each series.

Please see the [API Reference](#api-reference) for the full list of available options, which vary slightly between series types.

## Styling

Enable labels with `label.enabled`, then style them with the following options.

#### Label Styling

```tsx
import React, { useState } from "react";
import { createRoot } from "react-dom/client";
import { AgCharts } from "ag-charts-react";
import {
  AgBarSeriesOptions,
  AgCartesianChartOptions,
  BarSeriesModule,
  CategoryAxisModule,
  LegendModule,
  ModuleRegistry,
  NumberAxisModule,
} from "ag-charts-community";
import { DataType, data } from "./data";

function seriesLabel(): AgBarSeriesOptions<DataType>["label"] {
  return {
    enabled: true,
    fontWeight: "bold",
    placement: [
      "outside-end",
      "inside-center",
      "beside-after-center",
      "beside-before-center",
    ],
    orientation: "horizontal",
    border: { enabled: true, strokeWidth: 1 },
    insideStyle: {
      color: "white",
      fill: "black",
      fillOpacity: 0.6,
      border: { stroke: "white" },
    },
    outsideStyle: {
      color: "black",
      fill: "white",
      fillOpacity: 0.8,
      border: { stroke: "black" },
    },
  };
}
ModuleRegistry.registerModules([
  BarSeriesModule,
  LegendModule,
  CategoryAxisModule,
  NumberAxisModule,
]);

const ChartExample = () => {
  const [options, setOptions] = useState<AgCartesianChartOptions<DataType>>({
    title: { text: "Quarterly Revenue by Product Line ($m)" },
    data,
    series: [
      {
        type: "bar",
        xKey: "quarter",
        yKey: "hardware",
        yName: "Hardware",
        stacked: true,
        label: seriesLabel(),
      },
      {
        type: "bar",
        xKey: "quarter",
        yKey: "services",
        yName: "Services",
        stacked: true,
        label: seriesLabel(),
      },
      {
        type: "bar",
        xKey: "quarter",
        yKey: "software",
        yName: "Software",
        stacked: true,
        label: seriesLabel(),
      },
    ],
    axes: {
      x: { type: "category" },
      y: { type: "number", max: 90, title: { text: "Revenue ($m)" } },
    },
  });

  return <AgCharts options={options} />;
};

const root = createRoot(document.getElementById("root")!);
root.render(<ChartExample />);
```

[Live example: Label Styling](https://www.ag-grid.com/charts/reactFunctionalTs/series-labels/examples/label-showcase)

```js
{
    series: [
        {
            // ...
            label: {
                enabled: true,
            },
        },
    ],
}
```

In this example:

- The label text is styled with properties such as `color` and `fontWeight`. Other available options include `fontSize`, `fontStyle` and `fontFamily`.
- The label itself has a fill and border, configured with properties such as `fill` and `border`. Other available options include `fillOpacity`, `cornerRadius` and `padding`. See [Fills & Borders](https://www.ag-grid.com/charts/react/fills-borders/) for more details.
- The `insideStyle` and `outsideStyle` properties override these text and box styles for when the resolved label placement sits inside or outside the series node — used here to swap between a dark-on-light and light-on-dark treatment.
- Bar-family labels can additionally be rotated with `orientation`. See [Orientation](#orientation) for more details.
- Providing `placement` as an ordered array lets a label fall back to an alternative position. See [Placement](#placement) for more details.

## Placement

The available label positions are series-specific. These include `'inside-start'` or `'outside-end'` for a bar series, and `'top'` or `'left'` for a bubble series.

See the [API Reference](https://www.ag-grid.com/charts/options/) for the full list of placement values per series type.

#### Label Placement

```tsx
import React, { useState, Fragment } from "react";
import { createRoot } from "react-dom/client";
import { AgCharts } from "ag-charts-react";
import {
  AgBarSeriesOptions,
  AgBubbleSeriesOptions,
  AgCartesianChartOptions,
  BarSeriesModule,
  BubbleSeriesModule,
  CategoryAxisModule,
  LegendModule,
  ModuleRegistry,
  NumberAxisModule,
} from "ag-charts-community";
import {
  AgBarSeriesLabelPlacement,
  AgChartLabelCollisionPlacement,
} from "ag-charts-types";
import { BarDataType, BubbleDataType, barData, bubbleData } from "./data";
import clone from "clone";
import "./styles.css";

type SeriesType = "bubble" | "bar" | "bar-horizontal";

let spacing = 6;
function parsePlacement(value: string) {
  const placements = value.split(/,\s*/g);
  return (placements.length > 1 ? placements : placements[0]) as
    | AgChartLabelCollisionPlacement
    | AgChartLabelCollisionPlacement[]
    | AgBarSeriesLabelPlacement
    | AgBarSeriesLabelPlacement[];
}
ModuleRegistry.registerModules([
  BubbleSeriesModule,
  BarSeriesModule,
  LegendModule,
  CategoryAxisModule,
  NumberAxisModule,
]);

const ChartExample = () => {
  const [options, setOptions] = useState<
    AgCartesianChartOptions<BubbleDataType | BarDataType>
  >({
    title: { text: "Weather Station Readings" },
    data: bubbleData,
    series: [
      {
        type: "bubble",
        xKey: "temperature",
        yKey: "humidity",
        sizeKey: "windSpeed",
        labelKey: "station",
        maxSize: 60,
        label: {
          enabled: true,
          placement: "top",
          spacing,
        },
      },
    ],
    axes: {
      x: { type: "number", title: { text: "Temperature (°C)" } },
      y: { type: "number", title: { text: "Humidity (%)" } },
    },
  });

  const updateSpacingSlider = () => {
    const nextOptions = clone(options);

    const series = nextOptions.series![0] as
      | AgBubbleSeriesOptions<BubbleDataType>
      | AgBarSeriesOptions<BarDataType>;
    const placement = series.label!.placement;
    const isCentred = placement === "inside" || placement === "inside-center";
    (document.getElementById("spacingSlider") as HTMLInputElement).disabled =
      isCentred;

    setOptions(nextOptions);
  };

  const setSeriesType = (seriesType: SeriesType) => {
    const nextOptions = clone(options);

    document.getElementById("bubblePlacementRow")!.style.display =
      seriesType === "bubble" ? "" : "none";
    document.getElementById("barPlacementRow")!.style.display =
      seriesType === "bubble" ? "none" : "";
    if (seriesType === "bubble") {
      nextOptions.title = { text: "Weather Station Readings" };
      nextOptions.data = bubbleData;
      nextOptions.axes = {
        x: { type: "number", title: { text: "Temperature (°C)" } },
        y: { type: "number", title: { text: "Humidity (%)" } },
      };
      const bubblePlacementSelect = document.getElementById(
        "bubblePlacementSelect",
      ) as HTMLSelectElement;
      nextOptions.series = [
        {
          type: "bubble",
          xKey: "temperature",
          yKey: "humidity",
          sizeKey: "windSpeed",
          labelKey: "station",
          maxSize: 60,
          label: {
            enabled: true,
            placement: parsePlacement(bubblePlacementSelect.value) as
              | AgChartLabelCollisionPlacement
              | AgChartLabelCollisionPlacement[],
            spacing,
          },
        },
      ];
    } else {
      nextOptions.title = { text: "Quarterly Profit Change ($m)" };
      nextOptions.data = barData;
      // direction: 'horizontal' swaps which axis carries the category vs the value
      nextOptions.axes =
        seriesType === "bar-horizontal"
          ? {
              y: { type: "category" },
              x: { type: "number", title: { text: "Profit Change ($m)" } },
            }
          : {
              x: { type: "category" },
              y: { type: "number", title: { text: "Profit Change ($m)" } },
            };
      const barPlacementSelect = document.getElementById(
        "barPlacementSelect",
      ) as HTMLSelectElement;
      nextOptions.series = [
        {
          type: "bar",
          direction:
            seriesType === "bar-horizontal" ? "horizontal" : "vertical",
          xKey: "quarter",
          yKey: "profitChange",
          label: {
            enabled: true,
            placement: parsePlacement(barPlacementSelect.value) as
              | AgBarSeriesLabelPlacement
              | AgBarSeriesLabelPlacement[],
            spacing,
            truncate: false,
            formatter: (params) => `$${params.value}m`,
          },
        },
      ];
    }

    updateSpacingSlider();

    setOptions(nextOptions);
  };

  const setPlacement = (placement: string) => {
    const nextOptions = clone(options);

    const series = nextOptions.series![0] as
      | AgBubbleSeriesOptions<BubbleDataType>
      | AgBarSeriesOptions<BarDataType>;
    series.label!.placement = parsePlacement(placement);

    updateSpacingSlider();

    setOptions(nextOptions);
  };

  const setSpacing = (event: Event) => {
    const nextOptions = clone(options);

    spacing = Number((event.target as HTMLInputElement).value);
    document.getElementById("spacingValue")!.textContent = String(spacing);
    const series = nextOptions.series![0] as
      | AgBubbleSeriesOptions<BubbleDataType>
      | AgBarSeriesOptions<BarDataType>;
    series.label!.spacing = spacing;

    setOptions(nextOptions);
  };

  return (
    <Fragment>
      <div className="example-controls">
        <div className="controls-row">
          <span>Series:</span>
          <button onClick={() => setSeriesType("bubble")}>
            <code>Bubble</code>
          </button>
          <button onClick={() => setSeriesType("bar")}>
            <code>Bar</code>
          </button>
          <button onClick={() => setSeriesType("bar-horizontal")}>
            <code>Horizontal Bar</code>
          </button>
        </div>
        <div className="controls-row">
          <span>Placement:</span>
          <span id="bubblePlacementRow">
            <select
              id="bubblePlacementSelect"
              className="gap-right"
              onChange={(event) => setPlacement(event.target.value)}
            >
              <option value="top">Top</option>
              <option value="top-right">Top Right</option>
              <option value="right">Right</option>
              <option value="bottom-right">Bottom Right</option>
              <option value="bottom">Bottom</option>
              <option value="bottom-left">Bottom Left</option>
              <option value="left">Left</option>
              <option value="top-left">Top Left</option>
              <option value="inside">Centre (Inside)</option>
              <hr />
              <option value="top, bottom, left, right">
                Top + Bottom + Left + Right fallback
              </option>
              <option value="left, right">Left + Right fallback</option>
            </select>
          </span>
          <span id="barPlacementRow" style={{ display: "none" }}>
            <select
              id="barPlacementSelect"
              className="gap-right"
              onChange={(event) => setPlacement(event.target.value)}
            >
              <option value="outside-end">Outside End</option>
              <option value="outside-start">Outside Start</option>
              <option value="inside-end">Inside End</option>
              <option value="inside-start">Inside Start</option>
              <option value="inside-center">Centre (Inside)</option>
              <option value="beside-before-start">Beside Before Start</option>
              <option value="beside-before-center">Beside Before Centre</option>
              <option value="beside-before-end">Beside Before End</option>
              <option value="beside-after-start">Beside After Start</option>
              <option value="beside-after-center">Beside After Centre</option>
              <option value="beside-after-end">Beside After End</option>
              <hr />
              <option value="outside-end, inside-end">
                Outside End + Inside End fallback
              </option>
              <option value="inside-center, beside-after-center">
                Inside Centre + Beside After Centre fallback
              </option>
            </select>
          </span>
          <label htmlFor="spacingSlider">Spacing:</label>
          <input
            type="range"
            id="spacingSlider"
            min="0"
            max="20"
            defaultValue="6"
            onInput={(event) => setSpacing(event)}
            onChange={(event) => setSpacing(event)}
          />
          <span
            id="spacingValue"
            style={{
              display: "inline-block",
              minWidth: "3ch",
              textAlign: "right",
            }}
          >
            6
          </span>
        </div>
      </div>
      <div className="resizable-container">
        <AgCharts options={options} className="resizable" />
      </div>
    </Fragment>
  );
};

const root = createRoot(document.getElementById("root")!);
root.render(<ChartExample />);
```

[Live example: Label Placement](https://www.ag-grid.com/charts/reactFunctionalTs/series-labels/examples/label-position)

```js
{
    series: [
        {
            // ...
            label: {
                enabled: true,
                placement: ['top', 'bottom', 'left', 'right'],
                spacing: 6,
            },
        },
    ],
}
```

In this example:

- Providing `placement` as an ordered array allows the label to fallback to an alternative position if the first doesn't fit or collides with another item.
  - This is affected by [Orientation](#orientation) and other [Collision Avoidance](#collision-avoidance) options.
  - Resize the example to see the fallback placements in action.
- `spacing` sets the pixel distance between a label and its anchor and is ignored when the resolved placement is centred.

## Orientation

Bar-family series can rotate their labels using the `label.orientation` option. This accepts `'horizontal'`, `'vertical'` or `'vertical-reversed'`, or an ordered array of fallback orientations.

#### Label Orientation

```tsx
import React, { useState, Fragment } from "react";
import { createRoot } from "react-dom/client";
import { AgCharts } from "ag-charts-react";
import {
  AgBarSeriesOptions,
  AgCartesianChartOptions,
  BarSeriesModule,
  CategoryAxisModule,
  LegendModule,
  ModuleRegistry,
  NumberAxisModule,
} from "ag-charts-community";
import { AgChartLabelOrientation } from "ag-charts-types";
import { DataType, data } from "./data";
import clone from "clone";
import "./styles.css";

ModuleRegistry.registerModules([
  BarSeriesModule,
  LegendModule,
  CategoryAxisModule,
  NumberAxisModule,
]);

const ChartExample = () => {
  const [options, setOptions] = useState<AgCartesianChartOptions<DataType>>({
    title: { text: "Quarterly Profit Change ($m)" },
    data,
    series: [
      {
        type: "bar",
        xKey: "quarter",
        yKey: "profitChange",
        label: {
          enabled: true,
          placement: "inside-end",
          orientation: "horizontal",
          wrapping: "never",
          formatter: (params) =>
            `$${params.value}m profit${params.datum.note ? ` (${params.datum.note})` : ""}`,
        },
      },
    ],
    axes: {
      x: { type: "category" },
      y: { type: "number", title: { text: "Profit Change ($m)" } },
    },
  });

  const setOrientation = (orientation: string) => {
    const nextOptions = clone(options);

    const series = nextOptions.series![0] as AgBarSeriesOptions<DataType>;
    const orientations = orientation.split(
      /,\s*/g,
    ) as AgChartLabelOrientation[];
    series.label!.orientation =
      orientations.length > 1 ? orientations : orientations[0];

    setOptions(nextOptions);
  };

  return (
    <Fragment>
      <div className="example-controls">
        <div className="controls-row">
          <span>Orientation:</span>
          <select
            className="gap-right"
            onChange={(event) => setOrientation(event.target.value)}
          >
            <option value="horizontal">Horizontal</option>
            <option value="vertical">Vertical</option>
            <option value="vertical-reversed">Vertical Reversed</option>
            <hr />
            <option value="horizontal, vertical">
              Horizontal, Vertical fallback
            </option>
            <option value="vertical, horizontal">
              Vertical, Horizontal fallback
            </option>
          </select>
        </div>
      </div>
      <div className="resizable-container">
        <AgCharts options={options} className="resizable" />
      </div>
    </Fragment>
  );
};

const root = createRoot(document.getElementById("root")!);
root.render(<ChartExample />);
```

[Live example: Label Orientation](https://www.ag-grid.com/charts/reactFunctionalTs/series-labels/examples/label-orientation)

```js
{
    series: [
        {
            type: 'bar',
            // ...
            label: {
                enabled: true,
                orientation: ['horizontal', 'vertical'],
                wrapping: 'never',
            },
        },
    ],
}
```

In this example:

- Providing `orientation` as an ordered array allows the label to fallback to an alternative orientation if the first doesn't fit or collides with another item.
  - This is affected by [Placement](#placement) and other [Collision Avoidance](#collision-avoidance) options.
  - Resize the example to see the fallback placements in action.

## Collision Avoidance

As well as using [fallback placement](#placement) and [fallback orientation](#orientation) options, labels can also wrap, truncate or be hidden when they collide with other elements or don't fit within provided `maxWidth`/`maxHeight` values.

#### Label Fitting

```tsx
import React, { useState, Fragment } from "react";
import { createRoot } from "react-dom/client";
import { AgCharts } from "ag-charts-react";
import {
  AgBarSeriesOptions,
  AgCartesianChartOptions,
  BarSeriesModule,
  CategoryAxisModule,
  LegendModule,
  ModuleRegistry,
  NumberAxisModule,
} from "ag-charts-community";
import { TextWrap } from "ag-charts-types";
import { DataType, data } from "./data";
import clone from "clone";
import "./styles.css";

ModuleRegistry.registerModules([
  BarSeriesModule,
  LegendModule,
  CategoryAxisModule,
  NumberAxisModule,
]);

const ChartExample = () => {
  const [options, setOptions] = useState<AgCartesianChartOptions<DataType>>({
    title: { text: "Quarterly Revenue by Leading Division" },
    data,
    series: [
      {
        type: "bar",
        xKey: "quarter",
        yKey: "revenue",
        label: {
          enabled: true,
          placement: "inside-end",
          formatter: (params) => `$${params.value}m ${params.datum.division}`,
          maxWidth: 70,
          maxHeight: 54,
          wrapping: "on-space",
          truncate: true,
        },
      },
    ],
    axes: {
      x: { type: "category" },
      y: { type: "number", title: { text: "Revenue ($m)" } },
    },
  });

  const setMaxWidth = (event: Event) => {
    const nextOptions = clone(options);

    const value = Number((event.target as HTMLInputElement).value);
    document.getElementById("maxWidthValue")!.textContent = String(value);
    (nextOptions.series![0] as AgBarSeriesOptions<DataType>).label!.maxWidth =
      value;

    setOptions(nextOptions);
  };

  const setMaxHeight = (event: Event) => {
    const nextOptions = clone(options);

    const value = Number((event.target as HTMLInputElement).value);
    document.getElementById("maxHeightValue")!.textContent = String(value);
    (nextOptions.series![0] as AgBarSeriesOptions<DataType>).label!.maxHeight =
      value;

    setOptions(nextOptions);
  };

  const setWrapping = (wrapping: string) => {
    const nextOptions = clone(options);

    (nextOptions.series![0] as AgBarSeriesOptions<DataType>).label!.wrapping =
      wrapping as TextWrap;

    setOptions(nextOptions);
  };

  const setTruncate = (value: string) => {
    const nextOptions = clone(options);

    (nextOptions.series![0] as AgBarSeriesOptions<DataType>).label!.truncate =
      value === "enabled";

    setOptions(nextOptions);
  };

  return (
    <Fragment>
      <div className="example-controls">
        <div className="controls-row">
          <div className="gap-right">
            <label htmlFor="maxWidthSlider">Max Width:</label>
            <input
              type="range"
              id="maxWidthSlider"
              min="20"
              max="150"
              defaultValue="70"
              onInput={(event) => setMaxWidth(event)}
              onChange={(event) => setMaxWidth(event)}
            />
            <span
              id="maxWidthValue"
              style={{
                display: "inline-block",
                minWidth: "4ch",
                textAlign: "right",
              }}
            >
              70
            </span>
          </div>
          <div>
            <label htmlFor="maxHeightSlider">Max Height:</label>
            <input
              type="range"
              id="maxHeightSlider"
              min="10"
              max="80"
              defaultValue="54"
              onInput={(event) => setMaxHeight(event)}
              onChange={(event) => setMaxHeight(event)}
            />
            <span
              id="maxHeightValue"
              style={{
                display: "inline-block",
                minWidth: "4ch",
                textAlign: "right",
              }}
            >
              54
            </span>
          </div>
        </div>
        <div className="controls-row">
          <div className="gap-right">
            <label htmlFor="wrap-select">Wrapping:</label>
            <select
              id="wrap-select"
              onChange={(event) => setWrapping(event.target.value)}
            >
              <option value="on-space">on-space (default)</option>
              <option value="always">always</option>
              <option value="hyphenate">hyphenate</option>
              <option value="never">never</option>
            </select>
          </div>
          <div>
            <label htmlFor="truncate-select">Truncate:</label>
            <select
              id="truncate-select"
              onChange={(event) => setTruncate(event.target.value)}
            >
              <option value="enabled">Enabled</option>
              <option value="disabled">Disabled</option>
            </select>
          </div>
        </div>
      </div>
      <div className="resizable-container">
        <AgCharts options={options} className="resizable" />
      </div>
    </Fragment>
  );
};

const root = createRoot(document.getElementById("root")!);
root.render(<ChartExample />);
```

[Live example: Label Fitting](https://www.ag-grid.com/charts/reactFunctionalTs/series-labels/examples/label-fitting)

```js
{
    series: [
        {
            // ...
            label: {
                enabled: true,
                placement: 'inside-end',
                maxWidth: 70,
                maxHeight: 54,
                wrapping: 'on-space',
                truncate: true,
            },
        },
    ],
}
```

In this example:

- `maxWidth` and `maxHeight` specify the maximum label size.
- `wrapping` (`'on-space'`, `'always'`, `'hyphenate'`, `'never'`) controls how overflowing text wraps within the provided size or bar boundary.
- `truncate` truncates whatever still doesn't fit, appending an ellipsis.

Series label collision avoidance is separate from [axis label collision avoidance](https://www.ag-grid.com/charts/react/axes-labels/#collision-avoidance), which is configured independently on each axis.

### Hiding Labels

When any of these strategies are used but fail to find a satisfactory resolution, the label is hidden by default.

Use `collision.alwaysShow: true` to force the label to remain visible, or `collision.alwaysShow: false` to allow labels to be hidden even when no other strategies are enabled.

#### Label Collision Threshold

```tsx
import React, { useState, Fragment } from "react";
import { createRoot } from "react-dom/client";
import { AgCharts } from "ag-charts-react";
import {
  AgBubbleSeriesOptions,
  AgCartesianChartOptions,
  BubbleSeriesModule,
  LegendModule,
  ModuleRegistry,
  NumberAxisModule,
} from "ag-charts-community";
import { DataType, data } from "./data";
import clone from "clone";
import "./styles.css";

ModuleRegistry.registerModules([
  BubbleSeriesModule,
  LegendModule,
  NumberAxisModule,
]);

const ChartExample = () => {
  const [options, setOptions] = useState<AgCartesianChartOptions<DataType>>({
    title: { text: "Weather Station Readings" },
    data,
    series: [
      {
        type: "bubble",
        xKey: "temperature",
        yKey: "humidity",
        sizeKey: "windSpeed",
        labelKey: "station",
        label: {
          enabled: true,
          border: {
            enabled: true,
            stroke: {
              ref: "foregroundColor",
              mix: 0.5,
              onto: "backgroundColor",
            },
            strokeWidth: 2,
          },
          collision: {
            threshold: 4,
            alwaysShow: false,
          },
        },
      },
    ],
    axes: {
      x: { type: "number", title: { text: "Temperature (°C)" } },
      y: { type: "number", title: { text: "Humidity (%)" } },
    },
  });

  const updateThresholdSlider = () => {
    const nextOptions = clone(options);

    const series = nextOptions.series![0] as AgBubbleSeriesOptions<DataType>;
    (document.getElementById("thresholdSlider") as HTMLInputElement).disabled =
      Boolean(series.label!.collision!.alwaysShow);

    setOptions(nextOptions);
  };

  const setThreshold = (event: Event) => {
    const nextOptions = clone(options);

    const value = Number((event.target as HTMLInputElement).value);
    document.getElementById("thresholdValue")!.textContent = String(value);
    (
      nextOptions.series![0] as AgBubbleSeriesOptions<DataType>
    ).label!.collision!.threshold = value;

    setOptions(nextOptions);
  };

  const setAlwaysShow = (value: string) => {
    const nextOptions = clone(options);

    (
      nextOptions.series![0] as AgBubbleSeriesOptions<DataType>
    ).label!.collision!.alwaysShow = value === "show";

    updateThresholdSlider();

    setOptions(nextOptions);
  };

  return (
    <Fragment>
      <div className="example-controls">
        <div className="controls-row">
          <label htmlFor="thresholdSlider">Collision Threshold:</label>
          <input
            type="range"
            id="thresholdSlider"
            min="-10"
            max="5"
            defaultValue="4"
            onInput={(event) => setThreshold(event)}
            onChange={(event) => setThreshold(event)}
          />
          <span
            id="thresholdValue"
            style={{
              display: "inline-block",
              minWidth: "4ch",
              textAlign: "right",
            }}
          >
            4
          </span>
        </div>
        <div className="controls-row">
          <span>Colliding labels:</span>
          <select onChange={(event) => setAlwaysShow(event.target.value)}>
            <option value="hide">Hide</option>
            <option value="show">Keep visible</option>
          </select>
        </div>
      </div>
      <div className="resizable-container">
        <AgCharts options={options} className="resizable" />
      </div>
    </Fragment>
  );
};

const root = createRoot(document.getElementById("root")!);
root.render(<ChartExample />);
```

[Live example: Label Collision Threshold](https://www.ag-grid.com/charts/reactFunctionalTs/series-labels/examples/label-threshold)

```js
{
    series: [
        {
            // ...
            label: {
                enabled: true,
                collision: {
                    alwaysShow: true,
                },
            },
        },
    ],
}
```

### Threshold

Collisions are defined as the edge of one label hitting the edge of another element.

Use a `collision.threshold` value to ensure labels are a minimum pixel distance from obstacles, or a negative value to allow labels to overlap somewhat.

```js
{
    series: [
        {
            // ...
            label: {
                enabled: true,
                collision: {
                    threshold: 4,
                },
            },
        },
    ],
}
```

## API Reference

#### Label Options

| Property | Type | Default | Description |
| --- | --- | --- | --- |
| formatter | RichFormatter |  | A custom formatting function used to convert data values into text for display by labels. |
| format | string |  | Format string used when rendering labels. |
| itemStyler | Styler |  | Function used to style individual datum labels. |
| enabled | boolean |  | Whether the associated elements and properties should be used in the chart. |
| color | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for text elements. A colour string, or a theme-colour reference object. |
| fontSize | FontSize |  | The size of the font in pixels for text elements. |
| fontFamily | FontFamily |  | The font family for text elements. |
| fontStyle | FontStyle |  | The style to use for text elements. |
| fontWeight | FontWeight |  | The font weight to use for text elements. |
| border | BorderOptions |  | Stroke options for the box border. |
| border.enabled | boolean |  | Whether the associated elements and properties should be used in the chart. |
| border.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| border.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| border.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| cornerRadius | PixelSize |  | Apply rounded corners to the label box. |
| padding | PixelSize \| PaddingOptions |  | Distance between the label text and the border. A number applies uniform padding; an object sets each side. |
| fill | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor \| AgGradientColor \| AgPatternColor \| AgImageFill |  | The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill. |
| fillOpacity | Opacity |  | The opacity of the fill colour. |

#### Collision Avoidance

| Property | Type | Default | Description |
| --- | --- | --- | --- |
| collision | AgChartLabelCollisionOptions |  | Configuration controlling the spacing kept from obstacles and whether a label that cannot be placed clear of every obstacle is kept at its least-overflowing placement or hidden. |
| collision.threshold | PixelSize |  | Collision threshold in pixels. A positive value triggers avoidance strategies when labels are further away, a negative value allows labels to overlap without triggering avoidance. |
| collision.alwaysShow | boolean |  | Whether to keep a colliding label visible when a collision remains after every avoidance strategy has been applied. When `true` the label stays at the best available position; when `false` it is hidden instead. |
| maxWidth | PixelSize |  | Maximum width, in pixels, the label may occupy before it is wrapped or truncated to fit. |
| maxHeight | PixelSize |  | Maximum height, in pixels, the label may occupy before it is wrapped or truncated to fit. |
| wrapping | 'never' \| 'always' \| 'hyphenate' \| 'on-space' |  | Text wrapping strategy applied when the label is constrained by `maxWidth` or `maxHeight`. - `'always'` will always wrap text to fit within the bounds. - `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word. - `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the bounds, the text will be truncated. - `'never'` disables text wrapping. |
| truncate | boolean |  | Whether to truncate the label with an ellipsis when it does not fit within its bounds. |