---
title: "Animation"
enterprise: true
framework: javascript
version: "14.1.0"
---

# Animation

## Initial Load

Switch between the different series types below to see their initial load animations. Toggling items in the legend will also animate the series in and out.

#### Initial Load

```ts
import {
  AgCartesianChartOptions,
  AgCartesianSeriesTooltipRendererParams,
  AgChartOptions,
  AgCharts,
  AgPolarChartOptions,
  AgTooltipRendererResult,
  AnimationModule,
  AreaSeriesModule,
  BarSeriesModule,
  CategoryAxisModule,
  ContextMenuModule,
  CrosshairModule,
  DonutSeriesModule,
  LegendModule,
  LineSeriesModule,
  ModuleRegistry,
  NumberAxisModule,
  PieSeriesModule,
} from "ag-charts-enterprise";
import { DataType, getData } from "./data";

const numFormatter = new Intl.NumberFormat("en-US");
const tooltip = {
  renderer: ({
    datum,
    yKey,
    yName,
  }: AgCartesianSeriesTooltipRendererParams<DataType>): AgTooltipRendererResult => {
    return {
      data: [
        { label: yName!, value: numFormatter.format(Number(datum[yKey])) },
      ],
    };
  },
};
const barOptions: AgCartesianChartOptions<DataType> = {
  series: [
    {
      type: "bar",
      xKey: "station",
      yKey: "early",
      stacked: true,
      yName: "Early",
      tooltip,
    },
    {
      type: "bar",
      xKey: "station",
      yKey: "morningPeak",
      yName: "Morning peak",
      stacked: true,
      tooltip,
    },
    {
      type: "bar",
      xKey: "station",
      yKey: "interPeak",
      yName: "Between peak",
      stacked: true,
      tooltip,
    },
    {
      type: "bar",
      xKey: "station",
      yKey: "afternoonPeak",
      yName: "Afternoon peak",
      stacked: true,
      tooltip,
    },
    {
      type: "bar",
      xKey: "station",
      yKey: "evening",
      yName: "Evening",
      stacked: true,
      tooltip,
    },
  ],
  axes: {
    x: {
      type: "category",
      label: {
        wrapping: "on-space",
        autoRotate: false,
      },
    },
    y: {
      type: "number",
      label: {
        formatter: (params) => {
          return params.value / 1000 + "k";
        },
      },
    },
  },
};
const lineOptions: AgCartesianChartOptions<DataType> = {
  series: [
    {
      type: "line",
      xKey: "station",
      yKey: "early",
      yName: "Early",
      tooltip,
    },
    {
      type: "line",
      xKey: "station",
      yKey: "morningPeak",
      yName: "Morning peak",
      tooltip,
    },
    {
      type: "line",
      xKey: "station",
      yKey: "interPeak",
      yName: "Between peak",
      tooltip,
    },
    {
      type: "line",
      xKey: "station",
      yKey: "afternoonPeak",
      yName: "Afternoon peak",
      tooltip,
    },
    {
      type: "line",
      xKey: "station",
      yKey: "evening",
      yName: "Evening",
      tooltip,
    },
  ],
  axes: {
    x: {
      type: "category",
      label: {
        wrapping: "on-space",
        autoRotate: false,
      },
    },
    y: {
      type: "number",
      label: {
        formatter: (params) => {
          return params.value / 1000 + "k";
        },
      },
    },
  },
};
const areaOptions: AgCartesianChartOptions<DataType> = {
  series: [
    {
      type: "area",
      xKey: "station",
      yKey: "early",
      stacked: true,
      yName: "Early",
      tooltip,
    },
    {
      type: "area",
      xKey: "station",
      yKey: "morningPeak",
      yName: "Morning peak",
      stacked: true,
      tooltip,
    },
    {
      type: "area",
      xKey: "station",
      yKey: "interPeak",
      yName: "Between peak",
      stacked: true,
      tooltip,
    },
    {
      type: "area",
      xKey: "station",
      yKey: "afternoonPeak",
      yName: "Afternoon peak",
      stacked: true,
      tooltip,
    },
    {
      type: "area",
      xKey: "station",
      yKey: "evening",
      yName: "Evening",
      stacked: true,
      tooltip,
    },
  ],
  axes: {
    x: {
      type: "category",
      label: {
        wrapping: "on-space",
        autoRotate: false,
      },
    },
    y: {
      type: "number",
      label: {
        formatter: (params) => {
          return params.value / 1000 + "k";
        },
      },
    },
  },
};
const donutOptions: AgPolarChartOptions<DataType> = {
  series: [
    {
      type: "pie",
      title: {
        text: "Morning Peak",
      },
      calloutLabelKey: "station",
      legendItemKey: "station",
      angleKey: "morningPeak",
      outerRadiusRatio: 0.6,
    },
    {
      type: "donut",
      title: {
        text: "Afternoon Peak",
      },
      calloutLabelKey: "station",
      legendItemKey: "station",
      angleKey: "afternoonPeak",
      showInLegend: false,
    },
  ],
};
ModuleRegistry.registerModules([
  AnimationModule,
  AreaSeriesModule,
  BarSeriesModule,
  CategoryAxisModule,
  CrosshairModule,
  DonutSeriesModule,
  LegendModule,
  LineSeriesModule,
  NumberAxisModule,
  PieSeriesModule,
  ContextMenuModule,
]);

const options:
  | AgCartesianChartOptions<DataType>
  | AgPolarChartOptions<DataType> = {
  data: getData(),
  animation: {
    enabled: true,
  },
  ...barOptions,
};

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

const chart = AgCharts.create(options);

function changeSeriesBar() {
  options.series = barOptions.series;
  options.axes = barOptions.axes;

  chart.update(options);
}

function changeSeriesLine() {
  options.series = lineOptions.series;
  options.axes = lineOptions.axes;

  chart.update(options);
}

function changeSeriesArea() {
  options.series = areaOptions.series;
  options.axes = areaOptions.axes;

  chart.update(options);
}

function changeSeriesDonut() {
  options.series = donutOptions.series;
  options.axes = donutOptions.axes;

  chart.update(options);
}

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

[Live example: Initial Load](https://www.ag-grid.com/charts/typescript/animation/examples/initial-load)

## Data Updates

A data update animation is split into three sequential phases — remove, update then add, which can be observed for different series types in this example:

#### Line Series Data Updates

```ts
import {
  AgCartesianChartOptions,
  AgChartOptions,
  AgCharts,
  AgPolarChartOptions,
  AnimationModule,
  AreaSeriesModule,
  BarSeriesModule,
  CategoryAxisModule,
  ContextMenuModule,
  CrosshairModule,
  DonutSeriesModule,
  LegendModule,
  LineSeriesModule,
  ModuleRegistry,
  NumberAxisModule,
  PieSeriesModule,
} from "ag-charts-enterprise";
import { getData, random } from "./data";

let start = [120, 150, 130, 140, 80];
let variance = 20;
let offset = 0;
let length = 8;
let seed = 1234;
const barOptions: AgCartesianChartOptions = {
  series: [
    {
      type: "bar",
      xKey: "year",
      yKey: "one",
      yName: "One",
      stacked: true,
    },
    {
      type: "bar",
      xKey: "year",
      yKey: "two",
      yName: "Two",
      stacked: true,
    },
    {
      type: "bar",
      xKey: "year",
      yKey: "three",
      yName: "Three",
      stacked: true,
    },
    {
      type: "bar",
      xKey: "year",
      yKey: "four",
      yName: "Four",
      stacked: true,
    },
    {
      type: "bar",
      xKey: "year",
      yKey: "five",
      yName: "Five",
      stacked: true,
    },
  ],
  axes: {
    x: {
      type: "category",
      label: {
        autoRotate: false,
      },
    },
  },
};
const lineOptions: AgCartesianChartOptions = {
  series: [
    {
      type: "line",
      xKey: "year",
      yKey: "one",
      yName: "One",
    },
    {
      type: "line",
      xKey: "year",
      yKey: "two",
      yName: "Two",
    },
    {
      type: "line",
      xKey: "year",
      yKey: "three",
      yName: "Three",
    },
    {
      type: "line",
      xKey: "year",
      yKey: "four",
      yName: "Four",
    },
    {
      type: "line",
      xKey: "year",
      yKey: "five",
      yName: "Five",
    },
  ],
  axes: {
    x: {
      type: "number",
      nice: false,
      label: {
        autoRotate: false,
      },
    },
  },
};
const areaOptions: AgCartesianChartOptions = {
  series: [
    {
      type: "area",
      xKey: "year",
      yKey: "one",
      yName: "One",
      stacked: true,
    },
    {
      type: "area",
      xKey: "year",
      yKey: "two",
      yName: "Two",
      stacked: true,
    },
    {
      type: "area",
      xKey: "year",
      yKey: "three",
      yName: "Three",
      stacked: true,
    },
    {
      type: "area",
      xKey: "year",
      yKey: "four",
      yName: "Four",
      stacked: true,
    },
    {
      type: "area",
      xKey: "year",
      yKey: "five",
      yName: "Five",
      stacked: true,
    },
  ],
  axes: {
    x: {
      type: "number",
      nice: false,
      label: {
        autoRotate: false,
      },
    },
  },
};
const donutOptions: AgPolarChartOptions = {
  series: [
    {
      type: "pie",
      title: {
        text: "One",
      },
      calloutLabelKey: "year",
      legendItemKey: "year",
      angleKey: "one",
      outerRadiusRatio: 0.6,
    },
    {
      type: "donut",
      title: {
        text: "Two",
      },
      calloutLabelKey: "year",
      legendItemKey: "year",
      angleKey: "two",
      showInLegend: false,
    },
  ],
};
function getGeneratedData() {
  return getData(start, variance, offset, length, seed);
}
ModuleRegistry.registerModules([
  AnimationModule,
  AreaSeriesModule,
  BarSeriesModule,
  CategoryAxisModule,
  CrosshairModule,
  DonutSeriesModule,
  LegendModule,
  LineSeriesModule,
  NumberAxisModule,
  PieSeriesModule,
  ContextMenuModule,
]);

const options: AgCartesianChartOptions | AgPolarChartOptions = {
  animation: {
    enabled: true,
  },
  data: getGeneratedData(),
  ...barOptions,
};

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

const chart = AgCharts.create(options);

function changeSeriesBar() {
  variance = 20;
  offset = 0;
  length = 8;
  seed = 1234;
  options.series = barOptions.series;
  options.axes = barOptions.axes;
  options.data = getGeneratedData();

  chart.update(options);
}

function changeSeriesLine() {
  variance = 4;
  offset = 0;
  length = 30;
  seed = 1234;
  options.series = lineOptions.series;
  options.axes = lineOptions.axes;
  options.data = getGeneratedData();

  chart.update(options);
}

function changeSeriesArea() {
  variance = 20;
  offset = 0;
  length = 30;
  seed = 1234;
  options.series = areaOptions.series;
  options.axes = areaOptions.axes;
  options.data = getGeneratedData();

  chart.update(options);
}

function changeSeriesDonut() {
  variance = 30;
  offset = 0;
  length = 6;
  seed = 1234;
  options.series = donutOptions.series;
  options.axes = donutOptions.axes;
  options.data = getGeneratedData();

  chart.update(options);
}

function add() {
  offset++;
  length++;
  options.data = getGeneratedData();

  chart.update(options);
}

function remove() {
  if (options.series?.[0].type === "pie") offset--;
  length = Math.max(0, length - 1);
  options.data = getGeneratedData();

  chart.update(options);
}

function update() {
  seed = Math.floor(random() * 1000);
  options.data = getGeneratedData();

  chart.update(options);
}

function addRemoveUpdate() {
  if (options.series?.[0].type === "pie") offset--;
  if (options.series?.[0].type !== "pie") offset++;
  seed = Math.floor(random() * 1000);
  options.data = getGeneratedData();

  chart.update(options);
}

if (typeof window !== "undefined") {
  // Attach external event handlers to window so they can be called from index.html
  (<any>window).changeSeriesBar = changeSeriesBar;
  (<any>window).changeSeriesLine = changeSeriesLine;
  (<any>window).changeSeriesArea = changeSeriesArea;
  (<any>window).changeSeriesDonut = changeSeriesDonut;
  (<any>window).add = add;
  (<any>window).remove = remove;
  (<any>window).update = update;
  (<any>window).addRemoveUpdate = addRemoveUpdate;
}
```

[Live example: Line Series Data Updates](https://www.ag-grid.com/charts/typescript/animation/examples/data-updates)

## Duration

You can use the `duration` option to specify the length of all animations in milliseconds.

For an initial load, this is simply the duration of the whole animation.

For a data update, the duration is the total time of all three animation phases together — remove, update then add.

```js
{
    animation: {
        duration: 500,
    },
}
```

In this example, click a duration then change the series type to see the initial load animation.

#### Duration

```ts
import {
  AgCartesianChartOptions,
  AgCartesianSeriesTooltipRendererParams,
  AgChartOptions,
  AgCharts,
  AgPolarChartOptions,
  AgTooltipRendererResult,
  AnimationModule,
  AreaSeriesModule,
  BarSeriesModule,
  CategoryAxisModule,
  ContextMenuModule,
  CrosshairModule,
  DonutSeriesModule,
  LegendModule,
  LineSeriesModule,
  ModuleRegistry,
  NumberAxisModule,
  PieSeriesModule,
} from "ag-charts-enterprise";
import { DataType, getData } from "./data";

const numFormatter = new Intl.NumberFormat("en-US");
const tooltip = {
  renderer: ({
    datum,
    yKey,
    yName,
  }: AgCartesianSeriesTooltipRendererParams<DataType>): AgTooltipRendererResult => {
    return {
      data: [
        { label: yName!, value: numFormatter.format(Number(datum[yKey])) },
      ],
    };
  },
};
const barOptions: AgCartesianChartOptions<DataType> = {
  series: [
    {
      type: "bar",
      xKey: "station",
      yKey: "early",
      stacked: true,
      yName: "Early",
      tooltip,
    },
    {
      type: "bar",
      xKey: "station",
      yKey: "morningPeak",
      yName: "Morning peak",
      stacked: true,
      tooltip,
    },
    {
      type: "bar",
      xKey: "station",
      yKey: "interPeak",
      yName: "Between peak",
      stacked: true,
      tooltip,
    },
    {
      type: "bar",
      xKey: "station",
      yKey: "afternoonPeak",
      yName: "Afternoon peak",
      stacked: true,
      tooltip,
    },
    {
      type: "bar",
      xKey: "station",
      yKey: "evening",
      yName: "Evening",
      stacked: true,
      tooltip,
    },
  ],
  axes: {
    y: {
      type: "number",
      label: {
        formatter: (params) => {
          return params.value / 1000 + "k";
        },
      },
    },
  },
};
const lineOptions: AgCartesianChartOptions<DataType> = {
  series: [
    {
      type: "line",
      xKey: "station",
      yKey: "early",
      yName: "Early",
      tooltip,
    },
    {
      type: "line",
      xKey: "station",
      yKey: "morningPeak",
      yName: "Morning peak",
      tooltip,
    },
    {
      type: "line",
      xKey: "station",
      yKey: "interPeak",
      yName: "Between peak",
      tooltip,
    },
    {
      type: "line",
      xKey: "station",
      yKey: "afternoonPeak",
      yName: "Afternoon peak",
      tooltip,
    },
    {
      type: "line",
      xKey: "station",
      yKey: "evening",
      yName: "Evening",
      tooltip,
    },
  ],
  axes: {
    y: {
      type: "number",
      label: {
        formatter: (params) => {
          return params.value / 1000 + "k";
        },
      },
    },
  },
};
const areaOptions: AgCartesianChartOptions<DataType> = {
  series: [
    {
      type: "area",
      xKey: "station",
      yKey: "early",
      stacked: true,
      yName: "Early",
      tooltip,
    },
    {
      type: "area",
      xKey: "station",
      yKey: "morningPeak",
      yName: "Morning peak",
      stacked: true,
      tooltip,
    },
    {
      type: "area",
      xKey: "station",
      yKey: "interPeak",
      yName: "Between peak",
      stacked: true,
      tooltip,
    },
    {
      type: "area",
      xKey: "station",
      yKey: "afternoonPeak",
      yName: "Afternoon peak",
      stacked: true,
      tooltip,
    },
    {
      type: "area",
      xKey: "station",
      yKey: "evening",
      yName: "Evening",
      stacked: true,
      tooltip,
    },
  ],
  axes: {
    y: {
      type: "number",
      label: {
        formatter: (params) => {
          return params.value / 1000 + "k";
        },
      },
    },
  },
};
const donutOptions: AgPolarChartOptions<DataType> = {
  series: [
    {
      type: "pie",
      title: {
        text: "Morning Peak",
      },
      calloutLabelKey: "station",
      legendItemKey: "station",
      angleKey: "morningPeak",
      outerRadiusRatio: 0.6,
    },
    {
      type: "donut",
      title: {
        text: "Afternoon Peak",
      },
      calloutLabelKey: "station",
      legendItemKey: "station",
      angleKey: "afternoonPeak",
      showInLegend: false,
    },
  ],
};
ModuleRegistry.registerModules([
  AnimationModule,
  AreaSeriesModule,
  BarSeriesModule,
  CategoryAxisModule,
  CrosshairModule,
  DonutSeriesModule,
  LegendModule,
  LineSeriesModule,
  NumberAxisModule,
  PieSeriesModule,
  ContextMenuModule,
]);

const options:
  | AgCartesianChartOptions<DataType>
  | AgPolarChartOptions<DataType> = {
  data: getData(),
  animation: {
    enabled: true,
  },
  ...barOptions,
};

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

const chart = AgCharts.create(options);

function changeSeriesBar() {
  options.series = barOptions.series;
  options.axes = barOptions.axes;

  chart.update(options);
}

function changeSeriesLine() {
  options.series = lineOptions.series;
  options.axes = lineOptions.axes;

  chart.update(options);
}

function changeSeriesArea() {
  options.series = areaOptions.series;
  options.axes = areaOptions.axes;

  chart.update(options);
}

function changeSeriesDonut() {
  options.series = donutOptions.series;
  options.axes = donutOptions.axes;

  chart.update(options);
}

function changeDuration(duration: number) {
  options.animation = { duration };

  chart.update(options);
}

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

[Live example: Duration](https://www.ag-grid.com/charts/typescript/animation/examples/duration)

To highlight data changes with a flash effect, see [Flash On Update](https://www.ag-grid.com/charts/javascript/flash-on-update/).

## API Reference

| Property | Type | Default | Description |
| --- | --- | --- | --- |
| enabled | boolean |  | Set to `true` to enable the animation module. Defaults to `false` when `flashOnUpdate.enabled` is `true`. |
| duration | DurationMs |  | The total duration of the animation on initial load and updates. |