---
title: "Series Labels"
framework: javascript
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

```ts
import {
  AgBarSeriesOptions,
  AgCartesianChartOptions,
  AgCharts,
  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 options: 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)" } },
  },
};

options.container = document.getElementById("myChart");

const chart = AgCharts.create(options);
```

[Live example: Label Styling](https://www.ag-grid.com/charts/typescript/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/javascript/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

```ts
import {
  AgBarSeriesOptions,
  AgBubbleSeriesOptions,
  AgCartesianChartOptions,
  AgCharts,
  BarSeriesModule,
  BubbleSeriesModule,
  CategoryAxisModule,
  LegendModule,
  ModuleRegistry,
  NumberAxisModule,
} from "ag-charts-community";
import {
  AgBarSeriesLabelPlacement,
  AgChartLabelCollisionPlacement,
} from "ag-charts-types";
import { BarDataType, BubbleDataType, barData, bubbleData } from "./data";

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 options: 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 (%)" } },
  },
};

options.container = document.getElementById("myChart");

const chart = AgCharts.create(options);

function updateSpacingSlider() {
  const series = options.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;
  chart.update(options);
}

function setSeriesType(seriesType: SeriesType) {
  document.getElementById("bubblePlacementRow")!.style.display =
    seriesType === "bubble" ? "" : "none";
  document.getElementById("barPlacementRow")!.style.display =
    seriesType === "bubble" ? "none" : "";
  if (seriesType === "bubble") {
    options.title = { text: "Weather Station Readings" };
    options.data = bubbleData;
    options.axes = {
      x: { type: "number", title: { text: "Temperature (°C)" } },
      y: { type: "number", title: { text: "Humidity (%)" } },
    };
    const bubblePlacementSelect = document.getElementById(
      "bubblePlacementSelect",
    ) as HTMLSelectElement;
    options.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 {
    options.title = { text: "Quarterly Profit Change ($m)" };
    options.data = barData;
    // direction: 'horizontal' swaps which axis carries the category vs the value
    options.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;
    options.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();
  chart.update(options);
}

function setPlacement(placement: string) {
  const series = options.series![0] as
    | AgBubbleSeriesOptions<BubbleDataType>
    | AgBarSeriesOptions<BarDataType>;
  series.label!.placement = parsePlacement(placement);

  updateSpacingSlider();
  chart.update(options);
}

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

  chart.update(options);
}

if (typeof window !== "undefined") {
  // Attach external event handlers to window so they can be called from index.html
  (<any>window).setSeriesType = setSeriesType;
  (<any>window).setPlacement = setPlacement;
  (<any>window).setSpacing = setSpacing;
}
```

[Live example: Label Placement](https://www.ag-grid.com/charts/typescript/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

```ts
import {
  AgBarSeriesOptions,
  AgCartesianChartOptions,
  AgCharts,
  BarSeriesModule,
  CategoryAxisModule,
  LegendModule,
  ModuleRegistry,
  NumberAxisModule,
} from "ag-charts-community";
import { AgChartLabelOrientation } from "ag-charts-types";
import { DataType, data } from "./data";

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

const options: 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)" } },
  },
};

options.container = document.getElementById("myChart");

const chart = AgCharts.create(options);

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

  chart.update(options);
}

if (typeof window !== "undefined") {
  // Attach external event handlers to window so they can be called from index.html
  (<any>window).setOrientation = setOrientation;
}
```

[Live example: Label Orientation](https://www.ag-grid.com/charts/typescript/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

```ts
import {
  AgBarSeriesOptions,
  AgCartesianChartOptions,
  AgCharts,
  BarSeriesModule,
  CategoryAxisModule,
  LegendModule,
  ModuleRegistry,
  NumberAxisModule,
} from "ag-charts-community";
import { TextWrap } from "ag-charts-types";
import { DataType, data } from "./data";

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

const options: 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)" } },
  },
};

options.container = document.getElementById("myChart");

const chart = AgCharts.create(options);

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

  chart.update(options);
}

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

  chart.update(options);
}

function setWrapping(wrapping: string) {
  (options.series![0] as AgBarSeriesOptions<DataType>).label!.wrapping =
    wrapping as TextWrap;

  chart.update(options);
}

function setTruncate(value: string) {
  (options.series![0] as AgBarSeriesOptions<DataType>).label!.truncate =
    value === "enabled";

  chart.update(options);
}

if (typeof window !== "undefined") {
  // Attach external event handlers to window so they can be called from index.html
  (<any>window).setMaxWidth = setMaxWidth;
  (<any>window).setMaxHeight = setMaxHeight;
  (<any>window).setWrapping = setWrapping;
  (<any>window).setTruncate = setTruncate;
}
```

[Live example: Label Fitting](https://www.ag-grid.com/charts/typescript/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/javascript/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

```ts
import {
  AgBubbleSeriesOptions,
  AgCartesianChartOptions,
  AgCharts,
  BubbleSeriesModule,
  LegendModule,
  ModuleRegistry,
  NumberAxisModule,
} from "ag-charts-community";
import { DataType, data } from "./data";

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

const options: 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 (%)" } },
  },
};

options.container = document.getElementById("myChart");

const chart = AgCharts.create(options);
updateThresholdSlider();

function updateThresholdSlider() {
  const series = options.series![0] as AgBubbleSeriesOptions<DataType>;
  (document.getElementById("thresholdSlider") as HTMLInputElement).disabled =
    Boolean(series.label!.collision!.alwaysShow);
  chart.update(options);
}

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

  chart.update(options);
}

function setAlwaysShow(value: string) {
  (
    options.series![0] as AgBubbleSeriesOptions<DataType>
  ).label!.collision!.alwaysShow = value === "show";

  updateThresholdSlider();
  chart.update(options);
}

if (typeof window !== "undefined") {
  // Attach external event handlers to window so they can be called from index.html
  (<any>window).setThreshold = setThreshold;
  (<any>window).setAlwaysShow = setAlwaysShow;
}
```

[Live example: Label Collision Threshold](https://www.ag-grid.com/charts/typescript/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. |