Framework:Javascript Data GridAngular Data GridReact Data GridVue Data Grid

JavaScript Data Grid: Cell Rendering

By default the grid renders values into the cells as strings. If you want something more complex you use a cell renderer.

cellRenderer
any
Provide your own cell Renderer component for this column's cells.

The cell renderer for a column is set via colDef.cellRenderer and can be any of the following types:

  1. undefined: Grid renders the value as a string.
  2. String: The name of a cell renderer component.
  3. Class: Direct reference to a cell renderer component.
  4. Function: A function that returns either an HTML string or DOM element for display.

The code snippet below demonstrates each of these method types.

const gridOptions = {
    columnDefs: [
        // 1 - undefined - Grid renders the value as a string.
        {
            field: 'name',
            cellRenderer: undefined,
        },
        // 2 - String - The name of a cell renderer registered with the grid.
        {
            field: 'age',
            cellRenderer: 'agGroupCellRenderer',
        },
        // 3 - Class - Provide your own cell renderer component directly without registering.
        {
            field: 'sport',
            cellRenderer: MyCustomCellRendererClass,
        },
        // 4 - Function - A function that returns an HTML string or DOM element for display
        {
            field: 'year',
            cellRenderer: params => {
                // put the value in bold
                return 'Value is **' + params.value + '**';
            }
        }
    ],

    // other grid options ...
}

This remainder of this documentation page goes through the grid provided cell renderer's. To build your own cell renderer see the section Cell Rendering Components.

No Cell Renderer

If you have no requirements for custom cells, then you should use no cell renderer. Having no custom cell renderers will result in the fastest possible grid, as even the simplest cell renderer will result in some extra div's in the DOM

If you just want to do simple formatting of the data (eg currency or date formatting) then you can use colDef.valueFormatter.

valueFormatter
string | ValueFormatterFunc
A function or expression to format a value, should return a string. Not used for CSV export or copy to clipboard, only for UI cell rendering.
valueFormatter: string | ValueFormatterFunc<TData>;

interface ValueFormatterFunc<TData = any> {
    (params: ValueFormatterParams<TData>) : string
}

interface ValueFormatterParams<TData = any, TValue = any> {
  // Value for the cell. 
  value: TValue;
  // Row node for the given row 
  node: RowNode<TData> | null;
  // Data associated with the node 
  data: TData | undefined;
  // Column for this callback 
  column: Column;
  // ColDef provided for this column 
  colDef: ColDef<TData>;
  // The grid api. 
  api: GridApi<TData>;
  // The column api. 
  columnApi: ColumnApi;
  // Application context as set on `gridOptions.context`. 
  context: any;
}

Cell Renderer Components

Cell renderer components can be referenced by string or directly by class. They can be Provided Cell Renderers (that come with the grid) or Custom Cell Renderers (built by you).

Many Renderers One Column

It is also possible to use different renderers for different rows in the same column. To configure this set colDef.cellRendererSelector to a function that returns alternative values for cellRenderer and cellRendererParams.

The params passed to cellRendererSelector are the same as those passed to the Cell Renderer Component. Typically the selector will use this to check the rows contents and choose a renderer accordingly.

The result is an object with component and params to use instead of cellRenderer and cellRendererParams.

This following shows the Selector always returning back a Mood Cell Renderer:

cellRendererSelector: params => {
   return {
       component: GenderCellRenderer,
       params: {values: ['Male', 'Female']}
   };
}

However a selector only makes sense when a selection is made. The following demonstrates selecting between Mood and Gender Cell Renderers:

cellRendererSelector: params => {

   const type = params.data.type;

   if (type === 'gender') {
       return {
           component: GenderCellRenderer,
           params: {values: ['Male', 'Female']}
       };
   }

   if (type === 'mood') {
       return {
           component: MoodCellRenderer
       };
   }

   return undefined;
}

Here is a full example.

  • The column 'Value' holds data of different types as shown in the column 'Type' (numbers/genders/moods).
  • colDef.cellRendererSelector is a function that selects the renderer based on the row data.
  • The column 'Rendered Value' show the data rendered applying the component and params specified by colDef.cellRendererSelector

Example: Rendering Order

This example is configured with a custom cell render to make the order of cell rendering clear. Cells are numbered in order of rendering, and rendering function takes 10ms to execute, allowing you to see the process of incremental rendering more clearly. Note the cell values do not correspond to row or cell indexes.

Notice the following in the example below:

  • The grid remains interactive while cells are rendering. For example, you can click on any row to select it while cells are still rendering.
  • In initial rendering and when scrolling down, rows render top to bottom
  • When scrolling up, rows render bottom to top
  • Cells within a row render left to right regardless of scroll direction
  • Only visible cells are rendered. The grid contains 1000 rows and 20,000 cells. If you take about 10 seconds to scroll from the top to the bottom, only a few hundred cells will actually be rendered. Any cells that are scrolled into view and then back out of view again before they have a chance to be rendered will be skipped.

Provided Cell Renderers

The grid comes with some provided cell renderers out of the box. These cell renderers cover some common complex cell rendering requirements.