---
title: "Sparklines Overview"
enterprise: true
framework: react
version: "36.1.0"
---

# Sparklines Overview

This section introduces the grid's built-in Sparklines - mini charts that are optimised for grid cells that can be used to provide insights into data trends at a glance. These sparklines can be fully customised to application's requirements.

![Sparkline Overview](https://www.ag-grid.com/_astro/sparklines-overview.CNaxBxC7.png)

## Enabling Sparklines

To enable sparklines on a particular column, add the `agSparklineCellRenderer` as shown below:

```jsx
const [columnDefs, setColumnDefs] = useState([
    {
        field: 'change',
        cellRenderer: 'agSparklineCellRenderer',
    },
    // other column definitions ...
]);

<AgGridReact columnDefs={columnDefs} />
```

Note in the snippet above that specifying an `agSparklineCellRenderer` will display the data using the default `line` sparkline.

The following example shows the minimum configuration required to display data in a sparkline. Note the following:

- The **Change** column is configured to use an `agSparklineCellRenderer`.
- No sparkline options are supplied to the `agSparklineCellRenderer` so the default [Line Sparkline](https://www.ag-grid.com/react-data-grid/sparklines-line-customisation/) is used.
- An array of numbers is supplied as data to the **Change** column, which means no [Data Mapping](https://www.ag-grid.com/react-data-grid/sparklines-data/) is required.

#### Enabling Sparklines

```tsx
"use client";

import React, {
  useCallback,
  useMemo,
  useRef,
  useState,
  useEffect,
  StrictMode,
} from "react";
import { createRoot } from "react-dom/client";
import { AgGridReact, AgGridProvider } from "ag-grid-react";
import { AgChartsCommunityModule } from "ag-charts-community";
import {
  ClientSideRowModelModule,
  ColDef,
  ColGroupDef,
  GridApi,
  GridOptions,
  ModuleRegistry,
  enableDevValidations,
} from "ag-grid-community";
import {
  ClipboardModule,
  ContextMenuModule,
  SparklinesModule,
} from "ag-grid-enterprise";
import { getData } from "./data";

if (process.env.NODE_ENV !== "production") {
  enableDevValidations();
}

const modules = [
  ClientSideRowModelModule,
  SparklinesModule.with(AgChartsCommunityModule),
  ClipboardModule,
  ContextMenuModule,
];

const GridExample = () => {
  const gridRef = useRef<AgGridReact>(null);
  const containerStyle = useMemo(() => ({ width: "100%", height: "100%" }), []);
  const gridStyle = useMemo(() => ({ height: "100%", width: "100%" }), []);
  const [rowData, setRowData] = useState<any[]>(getData());
  const [columnDefs, setColumnDefs] = useState<ColDef[]>([
    { field: "symbol", maxWidth: 120 },
    { field: "name", minWidth: 250 },
    {
      field: "change",
      cellRenderer: "agSparklineCellRenderer",
    },
    {
      field: "volume",
      maxWidth: 140,
    },
  ]);
  const defaultColDef = useMemo<ColDef>(() => {
    return {
      flex: 1,
      minWidth: 100,
    };
  }, []);

  return (
    <AgGridProvider modules={modules}>
      <div style={containerStyle}>
        <div style={gridStyle}>
          <AgGridReact
            ref={gridRef}
            rowData={rowData}
            columnDefs={columnDefs}
            defaultColDef={defaultColDef}
            rowHeight={50}
          />
        </div>
      </div>
    </AgGridProvider>
  );
};

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

[Live example: Enabling Sparklines](https://www.ag-grid.com/examples/sparklines-overview/enabling-sparklines/reactFunctionalTs)

## Sparkline Customisation

The default Sparkline options act as a good starting point for most applications, however sparklines can be fully customised by overriding the default sparkline options.

Sparklines are customised by supplying `sparklineOptions` to the `cellRendererParams` on the Sparkline Cell Renderer as shown below:

```jsx
const [columnDefs, setColumnDefs] = useState([
    {
        cellRenderer: 'agSparklineCellRenderer',
        cellRendererParams: {
            sparklineOptions: {
                // Sparkline customisation goes here.
            }
        },
    },
    // other column definitions ...
]);

<AgGridReact columnDefs={columnDefs} />
```

Each Sparkline type contains specific `sparklineOptions` that can be overridden and are covered in the following sections:

- [Area Customisation](https://www.ag-grid.com/react-data-grid/sparklines-area-customisation/)
- [Bar Customisation](https://www.ag-grid.com/react-data-grid/sparklines-bar-customisation/)
- [Column Customisation](https://www.ag-grid.com/react-data-grid/sparklines-column-customisation/)
- [Line Customisation](https://www.ag-grid.com/react-data-grid/sparklines-line-customisation/)

The following sections are relevant to all sparkline types:

- [Sparkline Data](https://www.ag-grid.com/react-data-grid/sparklines-data/) - compares the different data formats that can be supplied to sparklines.
- [Axis Types](https://www.ag-grid.com/react-data-grid/sparklines-axis-types/) - compares the different axis types available to sparklines.
- [Sparkline Tooltips](https://www.ag-grid.com/react-data-grid/sparklines-tooltips/) - covers the various ways sparkline tooltips can be customised.
- [Points of Interest](https://www.ag-grid.com/react-data-grid/sparklines-points-of-interest/) - shows how points of interest can be formatted on sparklines.
- [Sparklines API](https://www.ag-grid.com/react-data-grid/sparklines-api-sparkline-options/) - shows more details on APIs available when using sparklines.