---
product: "AG Grid"
title: "Column Options Reference"
description: "Column Options Reference for Angular Data Grid. Browse all Column Properties used to configure Columns and Column Groups. Lists properties, types and defaults."
framework: angular
version: "36.2.0"
related:
    - title: "Overview"
      url: "https://www.ag-grid.com/archive/36.2.0/angular-data-grid/column-interface/"
    - title: "Column Reference"
      url: "https://www.ag-grid.com/archive/36.2.0/angular-data-grid/column-object/"
    - title: "Column Group Reference"
      url: "https://www.ag-grid.com/archive/36.2.0/angular-data-grid/column-object-group/"
    - title: "Events Reference"
      url: "https://www.ag-grid.com/archive/36.2.0/angular-data-grid/column-events/"
llms: "https://www.ag-grid.com/archive/36.2.0/llms.txt"
---

# Column Options Reference

Configuration for columns `ColDef<TData, TValue>` and column groups `ColGroupDef<TData>`.

### Columns

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `field` | `ColDefField` |  |  |  |
| `colId` | `string` |  |  |  |
| `type` | `string \| string[]` |  |  |  |
| `cellDataType` | `boolean \| string` |  |  |  |
| `valueGetter` | `string \| ValueGetterFunc` |  |  |  |
| `valueFormatter` | `string \| ValueFormatterFunc` |  |  |  |
| `refData` | `RefData` |  |  |  |
| `keyCreator` | `KeyCreatorFunc` |  |  |  |
| `equals` | `EqualsFunc` |  |  |  |
| `toolPanelClass` | `ToolPanelClass` |  |  |  |
| `suppressColumnsToolPanel` | `boolean` |  |  |  |
| `columnGroupShow` | `ColumnGroupShowType` |  |  |  |
| `icons` | `Icons` |  |  |  |
| `suppressNavigable` | `boolean \| SuppressNavigableCallback` |  |  |  |
| `suppressKeyboardEvent` | `SuppressKeyboardEventFunc` |  |  |  |
| `suppressPaste` | `boolean \| SuppressPasteCallback` |  |  |  |
| `suppressFillHandle` | `boolean` |  |  |  |
| `contextMenuItems` | `(DefaultMenuItem \| MenuItemDef)[] \| GetContextMenuItems` |  |  |  |
| `suppressNoteActions` | `boolean \| SuppressNoteActionsCallback` |  |  |  |
| `context` | `any` |  |  |  |

### Columns: Accessibility

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `cellAriaRole` | `string` |  |  |  |

### Columns: Aggregation

(Enterprise only) See [Aggregation](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/aggregation-columns/)

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `aggFunc` | `string \| IAggFunc \| null` |  |  |  |
| `initialAggFunc` | `string \| IAggFunc` |  |  |  |
| `valueIndex` | `number` |  |  |  |
| `initialValueIndex` | `number` |  |  |  |
| `enableValue` | `boolean` |  |  |  |
| `allowedAggFuncs` | `string[]` |  |  |  |
| `defaultAggFunc` | `string` |  |  |  |
| `showValuesAs` | `ShowValuesAsType \| ShowValuesAs \| null` |  |  |  |
| `initialShowValuesAs` | `ShowValuesAsType \| ShowValuesAs` |  |  |  |
| `showValuesAsDef` | `ShowValuesAsDef \| null` |  |  |  |
| `enableShowValuesAs` | `boolean` |  |  |  |

### Columns: Calculated Columns

See [Calculated Columns](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/calculated-columns/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `calculatedExpression` | `string` |  |  |  |

### Columns: Display

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `hide` | `boolean \| null` |  |  |  |
| `initialHide` | `boolean` |  |  |  |
| `lockVisible` | `boolean` |  |  |  |
| `lockPosition` | `boolean \| 'left' \| 'right'` |  |  |  |
| `suppressMovable` | `boolean` |  |  |  |
| `useValueFormatterForExport` | `boolean` |  |  |  |

### Columns: Editing

See [Cell Editing](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/cell-editing/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `editable` | `boolean \| EditableCallback` |  |  |  |
| `groupRowEditable` | `boolean \| GroupRowEditableCallback` |  |  |  |
| `groupRowValueSetter` | `boolean \| GroupRowValueSetterFunc \| GroupRowValueSetterOptions` |  |  |  |
| `valueSetter` | `string \| ValueSetterFunc` |  |  |  |
| `valueParser` | `string \| ValueParserFunc` |  |  |  |
| `cellEditor` | `any` |  |  |  |
| `cellEditorParams` | `any` |  |  |  |
| `cellEditorSelector` | `CellEditorSelectorFunc` |  |  |  |
| `cellEditorPopup` | `boolean` |  |  |  |
| `cellEditorPopupPosition` | `'over' \| 'under'` |  |  |  |
| `singleClickEdit` | `boolean` |  |  |  |
| `useValueParserForImport` | `boolean` |  |  |  |

### Columns: Events

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `onCellValueChanged` | `NewValueParams` |  |  |  |
| `onCellClicked` | `CellClickedEvent` |  |  |  |
| `onCellDoubleClicked` | `CellDoubleClickedEvent` |  |  |  |
| `onCellContextMenu` | `CellContextMenuEvent` |  |  |  |

### Columns: Filter

See [Filtering](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/filtering-overview/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `filter` | `any` |  |  |  |
| `filterParams` | `any` |  |  |  |
| `filterValueGetter` | `string \| ValueGetterFunc` |  |  |  |
| `getQuickFilterText` | `GetQuickFilterText` |  |  |  |
| `floatingFilter` | `boolean` |  |  |  |
| `floatingFilterComponent` | `any` |  |  |  |
| `floatingFilterComponentParams` | `any` |  |  |  |
| `suppressFiltersToolPanel` | `boolean` |  |  |  |
| `dateComponent` | `any` |  |  |  |
| `dateComponentParams` | `any` |  |  |  |

### Columns: Find

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `getFindText` | `GetFindTextFunc` |  |  |  |

### Columns: Formulas

See [Formulas](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/formulas/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `allowFormula` | `boolean` |  |  |  |

### Columns: Header

See [Column Headers](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/column-headers/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `headerName` | `string` |  |  |  |
| `headerNameEditable` | `boolean` |  |  |  |
| `headerValueGetter` | `string \| HeaderValueGetterFunc` |  |  |  |
| `headerTooltip` | `TooltipDefinition` |  |  |  |
| `headerStyle` | `HeaderStyle \| HeaderStyleFunc` |  |  |  |
| `headerClass` | `HeaderClass` |  |  |  |
| `headerComponent` | `any` |  |  |  |
| `headerComponentParams` | `any` |  |  |  |
| `wrapHeaderText` | `boolean` |  |  |  |
| `autoHeaderHeight` | `boolean` |  |  |  |
| `menuTabs` | `ColumnMenuTab[]` |  |  |  |
| `columnChooserParams` | `ColumnChooserParams` |  |  |  |
| `mainMenuItems` | `(DefaultMenuItem \| MenuItemDef)[] \| GetMainMenuItems` |  |  |  |
| `columnMenuItems` | `(DefaultColumnMenuItem \| MenuItemDef)[] \| GetColumnMenuItems` |  |  |  |
| `suppressHeaderMenuButton` | `boolean` |  |  |  |
| `suppressHeaderFilterButton` | `boolean` |  |  |  |
| `suppressHeaderContextMenu` | `boolean` |  |  |  |
| `suppressHeaderKeyboardEvent` | `SuppressHeaderKeyboardEventFunc` |  |  |  |
| `suppressFloatingFilterButton` | `boolean` |  |  |  |

### Columns: Integrated Charts

(Enterprise only) See [Integrated Charts](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/integrated-charts/)

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `chartDataType` | `'category' \| 'series' \| 'time' \| 'excluded'` |  |  |  |

### Columns: Pinned

See [Column Pinning](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/column-pinning/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `pinned` | `boolean \| 'left' \| 'right' \| null` |  |  |  |
| `initialPinned` | `boolean \| 'left' \| 'right'` |  |  |  |
| `lockPinned` | `boolean` |  |  |  |

### Columns: Pivoting

(Enterprise only) See [Pivoting](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/pivoting/)

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `pivot` | `boolean \| null` |  |  |  |
| `initialPivot` | `boolean` |  |  |  |
| `pivotIndex` | `number \| null` |  |  |  |
| `initialPivotIndex` | `number` |  |  |  |
| `enablePivot` | `boolean` |  |  |  |
| `pivotComparator` | `PivotComparatorFunc` |  |  |  |
| `pivotSort` | `SortDirection` |  |  |  |
| `initialPivotSort` | `SortDirection` |  |  |  |

### Columns: Rendering and Styling

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `cellStyle` | `CellStyle \| CellStyleFunc` |  |  |  |
| `cellClass` | `string \| string[] \| CellClassFunc` |  |  |  |
| `cellClassRules` | `CellClassRules` |  |  |  |
| `cellRenderer` | `any` |  |  |  |
| `cellRendererParams` | `any` |  |  |  |
| `cellRendererSelector` | `CellRendererSelectorFunc` |  |  |  |
| `loadingCellRenderer` | `any` |  |  |  |
| `loadingCellRendererParams` | `any` |  |  |  |
| `loadingCellRendererSelector` | `ILoadingCellRendererSelectorFunc` |  |  |  |
| `autoHeight` | `boolean` |  |  |  |
| `wrapText` | `boolean` |  |  |  |
| `enableCellChangeFlash` | `boolean` |  |  |  |

### Columns: Row Dragging

See [Row Dragging](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/row-dragging/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `rowDrag` | `boolean \| RowDragCallback` |  |  |  |
| `rowDragText` | `RowDragTextFunc` |  |  |  |
| `dndSource` | `boolean \| DndSourceCallback` |  |  |  |
| `dndSourceOnRowDrag` | `DndSourceOnRowDragFunc` |  |  |  |

### Columns: Row Grouping

(Enterprise only) See [Row Grouping](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/grouping/)

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `rowGroup` | `boolean \| null` |  |  |  |
| `initialRowGroup` | `boolean` |  |  |  |
| `rowGroupIndex` | `number \| null` |  |  |  |
| `initialRowGroupIndex` | `number` |  |  |  |
| `enableRowGroup` | `boolean` |  |  |  |
| `showRowGroup` | `string \| boolean` |  |  |  |
| `groupHierarchy` | `(GroupHierarchyParts \| string \| ColDef)[]` |  |  |  |

### Columns: Sort

See [Row Sorting](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/row-sorting/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `sortable` | `boolean` |  |  |  |
| `sort` | `SortDirection \| SortDef` |  |  |  |
| `initialSort` | `SortDirection \| SortDef` |  |  |  |
| `sortIndex` | `number \| null` |  |  |  |
| `initialSortIndex` | `number` |  |  |  |
| `sortingOrder` | `(SortDirection \| SortDef)[]` |  |  |  |
| `comparator` | `SortComparatorFn \| Partial<Record<SortType, SortComparatorFn>>` |  |  |  |
| `unSortIcon` | `boolean` |  |  |  |

### Columns: Spanning

See [Column](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/column-spanning/) / [Row](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/row-spanning/) Spanning

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `colSpan` | `ColSpanFunc` |  |  |  |
| `spanRows` | `boolean \| SpanRowsFunc` |  |  |  |

### Columns: Tooltips

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `tooltip` | `TooltipDefinition` |  |  |  |
| `tooltipComponent` | `any` |  |  |  |
| `tooltipComponentSelector` | `TooltipComponentSelectorFunc` |  |  |  |
| `tooltipComponentParams` | `any` |  |  |  |

### Columns: Width

See [Column Sizing](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/column-sizing/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `width` | `number` |  |  |  |
| `initialWidth` | `number` |  |  |  |
| `minWidth` | `number` |  |  |  |
| `maxWidth` | `number` |  |  |  |
| `flex` | `number \| null` |  |  |  |
| `initialFlex` | `number` |  |  |  |
| `resizable` | `boolean` |  |  |  |
| `suppressSizeToFit` | `boolean` |  |  |  |
| `suppressAutoSize` | `boolean` |  |  |  |

### Groups

For column groups, the property `children` is mandatory. When the grid sees `children` it knows it's a column group.

See [Column Groups](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/column-groups/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `children` | `(ColDef \| ColGroupDef)[]` |  |  |  |
| `groupId` | `string` |  |  |  |
| `marryChildren` | `boolean` |  |  |  |
| `openByDefault` | `boolean` |  |  |  |
| `columnGroupShow` | `ColumnGroupShowType` |  |  |  |
| `toolPanelClass` | `ToolPanelClass` |  |  |  |
| `suppressColumnsToolPanel` | `boolean` |  |  |  |
| `suppressFiltersToolPanel` | `boolean` |  |  |  |
| `tooltipComponent` | `any` |  |  |  |
| `tooltipComponentParams` | `any` |  |  |  |
| `context` | `any` |  |  |  |

### Groups:  Header

See [Column Headers](https://www.ag-grid.com/archive/36.2.0/angular-data-grid/column-headers/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `headerName` | `string` |  |  |  |
| `headerClass` | `HeaderClass` |  |  |  |
| `headerTooltip` | `TooltipDefinition` |  |  |  |
| `autoHeaderHeight` | `boolean` |  |  |  |
| `headerGroupComponent` | `any` |  |  |  |
| `headerGroupComponentParams` | `any` |  |  |  |
| `suppressSpanHeaderHeight` | `boolean` |  |  |  |
| `suppressStickyLabel` | `boolean` |  |  |  |