Framework:Javascript Data GridAngular Data GridReact Data GridVue Data Grid

Vue Data Grid: Master / Detail

Master Detail refers to a top level grid called a Master Grid having rows that expand. When the row is expanded, another grid is displayed with more details related to the expanded row. The grid that appears is known as the Detail Grid.

Enabling Master / Detail

Master / Detail can be enabled using the masterDetail grid option with detail rows configured using detailCellRendererParams as shown below:

<ag-grid-vue
    :masterDetail="masterDetail"
    :columnDefs="columnDefs"
    :detailCellRendererParams="detailCellRendererParams"
    /* other grid options ... */>
</ag-grid-vue>

// enable Master / Detail
this.masterDetail = true;

// the first Column is configured to use agGroupCellRenderer
this.columnDefs = [
    { field: 'name', cellRenderer: 'agGroupCellRenderer' },
    { field: 'account' }
];

// provide Detail Cell Renderer Params
this.detailCellRendererParams = {
    // provide the Grid Options to use on the Detail Grid
    detailGridOptions: {
        columnDefs: [
            { field: 'callId' },
            { field: 'direction' },
            { field: 'number'}
        ]
    },
    // get the rows for each Detail Grid
    getDetailRowData: params => {
        params.successCallback(params.data.callRecords);
    }
};

The example below shows a simple Master / Detail with all the above configured.

  1. Set the grid property masterDetail=true. This tells the grid to allow expanding rows to display Detail Grids.
  2. Set the Cell Renderer on one Master Grid column to agGroupCellRenderer. This tells the grid to use the Group Cell Renderer which in turn includes the expand / collapse functionality for that column.
  3. Set the Detail Cell Renderer* parameter detailGridOptions. This contains configuration for the Detail Grid such as what columns to display and what grid features you want enabled inside the Detail Grid.
  4. Provide a callback via the Detail Cell Renderer* parameter getDetailRowData. The callback is called for each Detail Grid and sets the rows to display in each Detail Grid.

To learn more about detailCellRendererParams configuration see the Detail Grids section.

Row Models

When using Master / Detail the Master Grid must be using either the Client-Side or Server-Side Row Models. It is not supported with the Viewport or Infinite Row Models.

The Detail Grid on the other hand can use any Row Model.

API Reference

Master Detail Properties

Top level Master Detail properties available on the Grid Options:

masterDetail
boolean
Set to true to enable Master Detail.
Default: false
isRowMaster
Function
Callback to be used with Master Detail to determine if a row should be a master row. If false is returned no detail row will exist for this row.
isRowMaster = (dataItem: any) => boolean;
detailCellRenderer
any
Provide a custom detailCellRenderer to use when a master row is expanded. See Custom Detail.
detailCellRendererParams
any
Specifies the params to be used by the Detail Cell Renderer. Can also be a function that provides the params to enable dynamic definitions of the params. See Detail Grids.
detailRowHeight
number
Set fixed height in pixels for each detail row. See Fixed Height.
detailRowAutoHeight
boolean
Set to true to have the detail grid dynamically change it's height to fit it's rows. See Auto Height.
embedFullWidthRows
boolean
Set to true to have the detail grid embedded in the master grid's container and so link their horizontal scrolling. See Syncing Detail Scrolling with Master.
keepDetailRows
boolean
Set to true to keep detail rows for when they are displayed again.
Default: false
keepDetailRowsCount
number
Sets the number of details rows to keep.
Default: 10

Detail Cell Renderer Params

Detail Cell Renderer parameters available on the detailCellRendererParams object:

Properties available on the IDetailCellRendererParams interface.

detailGridOptions
Provide Grid Options to use for the Detail Grid.
getDetailRowData
Function
A function that provides what rows to display in the Detail Grid.
getDetailRowData = (
    params: GetDetailRowDataParams
) => void;

interface GetDetailRowDataParams {
  // Row node for the details request. 
  node: RowNode;
  // Data for the current row. 
  data: any;
  // Success callback: pass the rows back for the grid request. 
  successCallback(rowData: any[]): void;
}
refreshStrategy
'rows' | 'everything' | 'nothing'
Defines how to refresh the Detail Grids as data is changing in the Master Grid.
template
string | TemplateFunc
Allows changing the template used around the Detail Grid.
template: string | TemplateFunc;

interface TemplateFunc {
    (params: ICellRendererParams) : string
}