---
title: "Column Reference"
framework: javascript
version: "36.1.0"
---

# Column Reference

Attributes and methods available on the `Column` instance.

### Clipboard

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isSuppressPaste` | `Function` |  |  | Returns `true` if paste is suppress for this column and row node. |

### Column Groups

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getParent` | `Function` |  |  | Returns the parent column group, if column grouping is active. |
| `getOriginalParent` | `Function` |  |  | Returns the parent column group, if this column is part of a column group. |
| `getColumnGroupShow` | `Function` |  |  | Returns whether this column should be shown when the group is open / closed or undefined if its always shown. |
| `getColumnGroupPaddingInfo` | `Function` |  |  | Returns column group padding info. |
| `isEmptyGroup` | `Function` |  |  | Returns `true` if this is an empty group. |

### Definitions

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getColId` | `Function` |  |  | Returns the unique ID for the column. Equivalent: `getId`, `getUniqueId` |
| `getColDef` | `Function` |  |  | Returns the column definition for this column. The column definition will be the result of merging the application provided column definition with any provided defaults (e.g. `defaultColDef` grid option, or column types. Equivalent: `getDefinition` |
| `getDisplayName` | `Function` |  |  | Returns this column's resolved display name — the header text after any `headerValueGetter` / locale resolution for `location` (default `'columnDrop'`), falling back to the colDef `headerName`, then the colId. |
| `getUserProvidedColDef` | `Function` |  |  | Returns the column definition provided by the application. This may not be correct, as items can be superseded by default column options. However it's useful for comparison, eg to know which application column definition matches that column. |
| `isColumn` | `true` |  |  | isColumn is always `true`. Used to distinguish between columns and column groups. |

### Display

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getLeft` | `Function` |  |  | Returns the left position of the column. |
| `isVisible` | `Function` |  |  | Returns `true` if the column is visible. |

### Editing

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isCellEditable` | `Function` |  |  | Returns `true` if the cell for this column is editable for the given `rowNode`, otherwise `false`. |
| `isSuppressFillHandle` | `Function` |  |  | Returns `true` if the fill handle is suppressed. |

### Events

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `addEventListener` | `Function` |  |  | Add an event listener to the column. |
| `removeEventListener` | `Function` |  |  | Remove event listener from the column. |

### Filtering

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isFilterAllowed` | `Function` |  |  | Returns `true` if column filtering is allowed. |
| `isFilterActive` | `Function` |  |  | Returns `true` if filter is active on the column. |

### Formulas

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isAllowFormula` | `Function` |  |  | Returns `true` if formulas are permitted for this column. |

### Keyboard

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isSuppressNavigable` | `Function` |  |  | Returns `true` if navigation is suppressed for the given column and rowNode. |

### Menu

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isMenuVisible` | `Function` |  |  | Returns `true` if a menu is visible for this column. |

### Moving

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isMoving` | `Function` |  |  | Returns `true` while the column is being moved. |

### Pinning

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getPinned` | `Function` |  |  | Returns the pinned state of the column. |
| `isPinned` | `Function` |  |  | Returns `true` if this column is pinned either left of right. |
| `isPinnedLeft` | `Function` |  |  | Returns `true` if this column is pinned left. |
| `isPinnedRight` | `Function` |  |  | Returns `true` if this column is pinned right. |
| `isFirstRightPinned` | `Function` |  |  | Returns `true` if this column is the first right pinned column. |
| `isLastLeftPinned` | `Function` |  |  | Returns `true` if this column is the last left pinned column. |

### Row Aggregation

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isAllowValue` | `Function` |  |  | Returns `true` if this column can be used as a value column. |
| `isValueActive` | `Function` |  |  | Returns `true` if value (aggregation) is currently active for this column. |
| `getAggFunc` | `Function` |  |  | If aggregation is set for the column, returns the aggregation function. |
| `getShowValuesAs` | `Function` |  |  | The active "Show Values As" mode for the column (`.type` is the mode name), or `null` if none. `TOut` is the transformed output type. The available modes are on getShowValuesAsDef. See [Show Values As](https://www.ag-grid.com/javascript-data-grid/aggregation-show-values-as/) for more information. |
| `getShowValuesAsDef` | `Function` |  |  | The column's resolved "Show Values As" config — every available mode plus the default precision — or `null` if the column has none. Not parameterised by output type: each mode has its own. The active mode is getShowValuesAs. |

### Row Dragging

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isRowDrag` | `Function` |  |  | Returns `true` if this column and row node can be dragged. |
| `isDndSource` | `Function` |  |  | Returns `true` if this column and row node allows dragging for native drag and drop. |

### Row Grouping

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isAllowRowGroup` | `Function` |  |  | Returns `true` if this column can be used as a row group column. |
| `isRowGroupActive` | `Function` |  |  | Returns `true` if row group is currently active for this column. |
| `isRowGroupDisplayed` | `Function` |  |  | Returns `true` if this column group is being used to display a row group value. |

### Row Pivoting

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isAllowPivot` | `Function` |  |  | Returns `true` if pivoting is allowed for this column |
| `isPivotActive` | `Function` |  |  | Returns `true` if pivot is currently active for this column. |
| `isPrimary` | `Function` |  |  | Returns `true` if column is a primary column, `false` if secondary. Secondary columns are used for pivoting. |

### Selection

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isCellCheckboxSelection` | `Function` |  |  | Returns `true` if this column and row node has checkbox selection. |

### Sizing

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `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. |
| `getMaxWidth` | `Function` |  |  | Returns the max width for the column. |
| `getFlex` | `Function` |  |  | Returns the `flex` value of the column or null if not set. |
| `isResizable` | `Function` |  |  | Returns `true` if this group is resizable. |
| `isAutoHeight` | `Function` |  |  | Returns `true` if the column has autoHeight enabled. |
| `isAutoHeaderHeight` | `Function` |  |  | Returns `true` if the column header has autoHeight enabled. |
| `getAutoHeaderHeight` | `Function` |  |  | Returns the auto header height. |
| `isSpanHeaderHeight` | `Function` |  |  | Returns `true` if this column spans the header height. |

### Sorting

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getSort` | `Function` |  |  | If sorting is active, returns the sort direction e.g. `'asc'` or `'desc'`. - **Prefer `getSortDef`** |
| `getSortDef` | `Function` |  |  | If sorting is active, returns the sort definition. |
| `isSortable` | `Function` |  |  | Returns `true` if sorting is enabled for this column via the `sortable` property. |
| `getSortIndex` | `Function` |  |  | Returns the sort index for this column. |

### Spanning

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getColSpan` | `Function` |  |  | Returns the column span for this column and row node. |

### Tooltip

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `isTooltipEnabled` | `Function` |  |  | Returns `true` if a tooltip is enabled for this column. |