Interface GridColumnGroupHeaderParams

Object passed as parameter in the column group header renderer.

interface GridColumnGroupHeaderParams {
    colIndex: number;
    depth: number;
    description?: string;
    fields: string[];
    groupId: null | string;
    headerName?: string;
    isLastColumn: boolean;
    maxDepth: number;
}

Hierarchy

  • Pick<GridColumnGroup, "headerName" | "description">
    • GridColumnGroupHeaderParams

Properties

colIndex depth description? fields groupId headerName? isLastColumn maxDepth

Properties

colIndex

colIndex: number

The column index (0 based).

depth

depth: number

The number parent the group have.

Optionaldescription

description?: string

The tooltip text shown when the column header name is truncated.

fields

fields: string[]

The column fields included in the group (including nested ones).

groupId

groupId: null | string

A unique string identifying the group.

OptionalheaderName

headerName?: string

The title displayed in the column header cell.

isLastColumn

isLastColumn: boolean

Indicate if the group is the last one for the given depth.

maxDepth

maxDepth: number

The maximal depth among visible columns.

Settings

Member Visibility

On This Page

Properties