Search

React Data GridMaster / Detail - Detail Height

Enterprise

This section shows how the detail height can be customised to suit application requirements.

Detail Height Options

The default height of each detail section (ie the row containing the Detail Grid in the master) is fixed at 300px. The height does not change based on how much data there is to display in the detail section.

To change the height of the details section from the default you have the following options:

  • Fixed Height: a custom fixed height can be provided for all detail sections instead of the default 300px.

  • Auto Height: detail sections can auto-size to fit based off the contents.

  • Dynamic Height: different heights can be provided for each detail section.

Fixed Height

Use the grid property detailRowHeight to set a fixed height for each detail row.

// statically fix row height for all detail grids
const detailRowHeight = 200;

<AgGridReact detailRowHeight={detailRowHeight} />

The following example sets a fixed row height for all detail rows.

Auto Height

Set grid property detailRowAutoHeight=true to have the detail grid to dynamically change its height to fit its rows.

// dynamically set row height for all detail grids
const detailRowAutoHeight = true;

<AgGridReact detailRowAutoHeight={detailRowAutoHeight} />

If you are not providing your own Detail Cell Renderer, then there is nothing else to be concerned about.

If you are providing your own Detail Cell Renderer, then you need to make sure the top most element of the Detail Cell Renderer has the correct height, as this is what the grid checks and matches the row height to. So make sure the CSS on the top most element is set so that its height is correct.

When using Auto Height feature, the Detail Grid will render all of its rows all the time. Row Virtualisation will not happen. This means if the Detail Grid has many rows, it could slow down your application and could result in stalling the browser.

Do not use Auto Height if you have many rows (eg 100+) in the Detail Grids. To know if this is a concern for your grid and dataset, try it out and check the performance.

Dynamic Height

Use the callback getRowHeight(params) to set height for each row individually. This is a specific use of the callback that is explained in more detail in Get Row Height

getRowHeight
Function
Callback version of property rowHeight to set height for each row individually. Function should return a positive number of pixels, or return null/undefined to use the default row height.

Note that this callback gets called for all rows in the Master Grid, not just rows containing Detail Grids. If you do not want to set row heights explicitly for other rows simply return undefined / null and the grid will ignore the result for that particular row.

// dynamically assigning detail row height
const getRowHeight = params => {
    const isDetailRow = params.node.detail;
    // for all rows that are not detail rows, return nothing
    if (!isDetailRow) { return undefined; }

    // otherwise return height based on number of rows in detail grid
    const detailPanelHeight = params.data.children.length * 50;
    return detailPanelHeight;
};

<AgGridReact getRowHeight={getRowHeight} />

The following example demonstrates dynamic detail row heights: