---
title: "Column Group Reference"
framework: vue
version: "36.1.0"
---

# Column Group Reference

Attributes and methods available on the `ColumnGroup` and `ProvidedColumnGroup` instances.

### ColumnGroup

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getColGroupDef` | `Function` |  |  | Returns the column group definition for this column. The column group definition will be the result of merging the application provided column group definition with any provided defaults (e.g. `defaultColGroupDef` grid option. |
| `getGroupId` | `Function` |  |  | Returns the group column id. |
| `getDisplayName` | `Function` |  |  | Returns this group's resolved display name for `location` (default `'columnDrop'`), falling back to the colGroupDef `headerName`, then the group id. |
| `getProvidedColumnGroup` | `Function` |  |  | Returns the provided column group |
| `getChildren` | `Function` |  |  | Returns the children of this group if they exist or `null` |
| `getDisplayedChildren` | `Function` |  |  | Returns the displayed children of this group. |
| `getLeafColumns` | `Function` |  |  | Returns the leaf columns of this group. |
| `getDisplayedLeafColumns` | `Function` |  |  | Returns the displayed leaf columns of this group. |
| `isResizable` | `Function` |  |  | Returns `true` if this group is resizable. |
| `isExpandable` | `Function` |  |  | Returns `true` if this column group is expandable. |
| `isExpanded` | `Function` |  |  | Returns `true` if this column group is expanded. |
| `isPadding` | `Function` |  |  | Returns `true` if this column group is a padding group that is used to correctly align column groups / children. |
| `getPaddingLevel` | `Function` |  |  | Returns the padding level of this padding group. |
| `isColumn` | `false` |  |  | isColumn is always `false`. Used to distinguish between columns and column groups. |
| `getActualWidth` | `Function` |  |  | Returns the current width of the column. If the column is resized, the actual width is the new size. |
| `getMinWidth` | `Function` |  |  | Returns the minWidth of the column or the default min width. |
| `getLeft` | `Function` |  |  | Returns the left position of the column. |
| `getColumnGroupShow` | `Function` |  |  | Returns whether this column should be shown when the group is open / closed or undefined if its always shown. |
| `getParent` | `Function` |  |  | Returns the parent column group, if column grouping is active. |
| `isEmptyGroup` | `Function` |  |  | Returns `true` if this is an empty group. |
| `isMoving` | `Function` |  |  | Returns `true` while the column is being moved. |
| `getPinned` | `Function` |  |  | Returns the pinned state of the column. |

### ProvidedColumnGroup

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getOriginalParent` | `Function` |  |  | Returns the parent column group, if this column is part of a column group. |
| `getLevel` | `Function` |  |  | Returns the level of this group. |
| `isPadding` | `Function` |  |  | Returns `true` if this column group is a padding group that is used to correctly align column groups / children. |
| `isExpandable` | `Function` |  |  | Returns `true` if this column group is expandable. |
| `isExpanded` | `Function` |  |  | Returns `true` if this column group is expanded. |
| `getGroupId` | `Function` |  |  | Returns the group column id. |
| `getChildren` | `Function` |  |  | Returns the children of this group. |
| `getColGroupDef` | `Function` |  |  | Returns the column group definition for this column. The column group definition will be the result of merging the application provided column group definition with any provided defaults (e.g. `defaultColGroupDef` grid option. |
| `getLeafColumns` | `Function` |  |  | Returns the leaf columns of this group. |
| `isColumn` | `false` |  |  | isColumn is always `false`. Used to distinguish between columns and column groups. |
| `isVisible` | `Function` |  |  | Returns `true` if the column is visible. |
| `getColumnGroupShow` | `Function` |  |  | Returns whether this column should be shown when the group is open / closed or undefined if its always shown. |