# Column Technical Reference

Canonical page: https://www.adaptabletools.com/docs/technical-reference-column

-----------

## Column Options

This class includes an option to show a warning if it cannot find a provided Column.

### `showMissingColumnsWarning`

Show a Warning when Columns are Missing

By default AdapTable will display an error message in the Console if it encounters a Column that has not been defined in AG Grid GridOptions.

A common occurrence is if the [Primary Key](https://www.adaptabletools.com/docs/getting-started-primary-key/index.md) property exists in the Data Source but is not an AG Grid column

Set this property to false to turn off this warning:

```ts {4}
// Do not show Error Messages in Console for missing Columns
const adaptableOptions: AdaptableOptions = {
  columnOptions: {
    showMissingColumnsWarning: false,
  },
};
```

| Property | Type | Description | Default |
| --- | --- | --- | --- |
| [addColumnGroupToColumnFriendlyName](https://www.adaptabletools.com/docs/reference/columnoptions.md#addcolumngrouptocolumnfriendlyname) | `boolean` | Appends the name of the Column Group to a Column's Friendly Name | false |
| [columnFriendlyName](https://www.adaptabletools.com/docs/reference/columnoptions.md#columnfriendlyname) | `(columnFriendlyNameContext: `[`ColumnFriendlyNameContext`](https://www.adaptabletools.com/docs/reference/columnfriendlynamecontext.md)`) => string \| undefined` | Provide an alternative Friendly Name for a Column | undefined |
| [columnHeader](https://www.adaptabletools.com/docs/reference/columnoptions.md#columnheader) | `(context: `[`ColumnHeaderContext`](https://www.adaptabletools.com/docs/reference/columnheadercontext.md)`) => string` | Provide a custom Header Name for a Table or Pivot Column.<br/><br/>Always invoked when provided, including when the current Layout has a<br/>caption for the Column. Use `layoutSpecificHeaderName` on the context to<br/>honour a user override, `colDefHeaderName` for the AG Grid header, or<br/>return your own value. |   |
| [columnTypes](https://www.adaptabletools.com/docs/reference/columnoptions.md#columntypes) | `TypeHint<string, `[`AdaptableColumnTypeName`](https://www.adaptabletools.com/docs/reference/adaptablecolumntypename.md)`>[] \| ((context: `[`ColumnTypesContext`](https://www.adaptabletools.com/docs/reference/columntypescontext.md)`) => TypeHint<string, `[`AdaptableColumnTypeName`](https://www.adaptabletools.com/docs/reference/adaptablecolumntypename.md)`>[])` | Optional list of Column Types - used for Scope and creating Special Columns | Empty Array |
| [showMissingColumnsWarning](https://www.adaptabletools.com/docs/reference/columnoptions.md#showmissingcolumnswarning) | `boolean` | Log warning to console if AdapTable cannot find a column | true |

`columnTypes` entries are an [`AdaptableColumnTypeName`](https://www.adaptabletools.com/docs/reference/adaptablecolumntypename.md):

[See API: adaptablecolumntypename](https://www.adaptabletools.com/docs/reference/adaptablecolumntypename.md)

`columnFriendlyName` receives a [`ColumnFriendlyNameContext`](https://www.adaptabletools.com/docs/reference/columnfriendlynamecontext.md):

| Property | Type | Description |
| --- | --- | --- |
| [agColumn](https://www.adaptabletools.com/docs/reference/columnfriendlynamecontext.md#agcolumn) | `Column` | AG Grid ColDef for the Column |
| [colId](https://www.adaptabletools.com/docs/reference/columnfriendlynamecontext.md#colid) | `string` | Id of the Column |
| [columnGroup](https://www.adaptabletools.com/docs/reference/columnfriendlynamecontext.md#columngroup) | [`AdaptableColumnGroup`](https://www.adaptabletools.com/docs/reference/adaptablecolumngroup.md) | Column Group Information |
| [displayName](https://www.adaptabletools.com/docs/reference/columnfriendlynamecontext.md#displayname) | `string` | AG Grid Display Name |
| [adaptableContext](https://www.adaptabletools.com/docs/reference/columnfriendlynamecontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` |

`columnHeader` receives a [`ColumnHeaderContext`](https://www.adaptabletools.com/docs/reference/columnheadercontext.md). The context is one of:

| Property | Type | Description |
| --- | --- | --- |
| [aggregation](https://www.adaptabletools.com/docs/reference/tablecolumnheadercontext.md#aggregation) | `string` | Aggregation function of Column (optional) |
| [columnId](https://www.adaptabletools.com/docs/reference/tablecolumnheadercontext.md#columnid) | `string` | Id of the Column |
| [columnType](https://www.adaptabletools.com/docs/reference/tablecolumnheadercontext.md#columntype) | `'tableColumn'` | Table Column (created in Table Layouts) |
| [adaptableContext](https://www.adaptabletools.com/docs/reference/tablecolumnheadercontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` |

| Property | Type | Description |
| --- | --- | --- |
| [childrenColumnIds](https://www.adaptabletools.com/docs/reference/tablecolumngroupheadercontext.md#childrencolumnids) | `string[]` | Ids of Column Group&#39;s children |
| [columnType](https://www.adaptabletools.com/docs/reference/tablecolumngroupheadercontext.md#columntype) | `'tableColumnGroup'` | Table Column Group (used when Column Grouping in Table Layouts) |
| [groupId](https://www.adaptabletools.com/docs/reference/tablecolumngroupheadercontext.md#groupid) | `string` | Id of Column Group |
| [state](https://www.adaptabletools.com/docs/reference/tablecolumngroupheadercontext.md#state) | `'expanded' \| 'collapsed'` | Expanded / Collapsed state of Column Group |
| [adaptableContext](https://www.adaptabletools.com/docs/reference/tablecolumngroupheadercontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` |

| Property | Type | Description |
| --- | --- | --- |
| [columnId](https://www.adaptabletools.com/docs/reference/autogroupcolumnheadercontext.md#columnid) | `string` | Id of the Column |
| [columnType](https://www.adaptabletools.com/docs/reference/autogroupcolumnheadercontext.md#columntype) | `'autoGroupColumn'` | Auto-generated Row Group Column (when RowGroupDisplayType is `single`) |
| [groupedColumnIds](https://www.adaptabletools.com/docs/reference/autogroupcolumnheadercontext.md#groupedcolumnids) | `string[]` | Ids of all Row Grouped Columns |
| [adaptableContext](https://www.adaptabletools.com/docs/reference/autogroupcolumnheadercontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` |

| Property | Type | Description |
| --- | --- | --- |
| [columnId](https://www.adaptabletools.com/docs/reference/rowgroupcolumnheadercontext.md#columnid) | `string` | Id of the Column |
| [columnType](https://www.adaptabletools.com/docs/reference/rowgroupcolumnheadercontext.md#columntype) | `'rowGroupColumn'` | A Row Grouped Column (created in both Table and Pivot Layout) |
| [groupColumnId](https://www.adaptabletools.com/docs/reference/rowgroupcolumnheadercontext.md#groupcolumnid) | `string` | Id of Row Grouped Column |
| [adaptableContext](https://www.adaptabletools.com/docs/reference/rowgroupcolumnheadercontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` |

| Property | Type | Description |
| --- | --- | --- |
| [columnType](https://www.adaptabletools.com/docs/reference/pivotcolumngroupheadercontext.md#columntype) | `'pivotColumnGroup'` | Pivot Column Group (created for each distinct value in a PivotColumn) |
| [groupId](https://www.adaptabletools.com/docs/reference/pivotcolumngroupheadercontext.md#groupid) | `string` | Id of generated Column Group |
| [pivotKeys](https://www.adaptabletools.com/docs/reference/pivotcolumngroupheadercontext.md#pivotkeys) | `string[]` | Pivot Keys for Column Group |
| [state](https://www.adaptabletools.com/docs/reference/pivotcolumngroupheadercontext.md#state) | `'expanded' \| 'collapsed'` | Expanded / Collapsed state of Column Group |
| [adaptableContext](https://www.adaptabletools.com/docs/reference/pivotcolumngroupheadercontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` |

| Property | Type | Description |
| --- | --- | --- |
| [aggregatedColumnId](https://www.adaptabletools.com/docs/reference/pivotresultcolumnheadercontext.md#aggregatedcolumnid) | `string` | Id of Pivot Aggregated Column |
| [aggregation](https://www.adaptabletools.com/docs/reference/pivotresultcolumnheadercontext.md#aggregation) | `string` | Aggregation function of Column |
| [columnId](https://www.adaptabletools.com/docs/reference/pivotresultcolumnheadercontext.md#columnid) | `string` | Id of generated Column |
| [columnType](https://www.adaptabletools.com/docs/reference/pivotresultcolumnheadercontext.md#columntype) | `'pivotResultColumn'` | Pivot Result Column (unique intersection of PivotAggregationColumn and PivotColumn) |
| [pivotKeys](https://www.adaptabletools.com/docs/reference/pivotresultcolumnheadercontext.md#pivotkeys) | `string[]` | Current Pivot Keys |
| [adaptableContext](https://www.adaptabletools.com/docs/reference/pivotresultcolumnheadercontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` |

| Property | Type | Description |
| --- | --- | --- |
| [aggregatedColumnId](https://www.adaptabletools.com/docs/reference/pivotgrandtotalheadercontext.md#aggregatedcolumnid) | `string` | Id of Pivot Aggregated Column |
| [aggregation](https://www.adaptabletools.com/docs/reference/pivotgrandtotalheadercontext.md#aggregation) | `string` | Aggregation function of Column |
| [columnType](https://www.adaptabletools.com/docs/reference/pivotgrandtotalheadercontext.md#columntype) | `'pivotGrandTotal'` | Pivot Grand Total Column |
| [adaptableContext](https://www.adaptabletools.com/docs/reference/pivotgrandtotalheadercontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` |

| Property | Type | Description |
| --- | --- | --- |
| [aggregation](https://www.adaptabletools.com/docs/reference/pivotcolumntotalheadercontext.md#aggregation) | `string` | Aggregation function of Column |
| [columnType](https://www.adaptabletools.com/docs/reference/pivotcolumntotalheadercontext.md#columntype) | `'pivotColumnTotal'` | Pivot Column Total |
| [pivotColumnId](https://www.adaptabletools.com/docs/reference/pivotcolumntotalheadercontext.md#pivotcolumnid) | `string` | Id of Pivot Column |
| [pivotKey](https://www.adaptabletools.com/docs/reference/pivotcolumntotalheadercontext.md#pivotkey) | `string` | Key (i.e. column value) of Pivot Column |
| [adaptableContext](https://www.adaptabletools.com/docs/reference/pivotcolumntotalheadercontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` |

| Property | Type | Description |
| --- | --- | --- |
| [aggregatedColumnId](https://www.adaptabletools.com/docs/reference/pivotaggregationtotalheadercontext.md#aggregatedcolumnid) | `string` | Id of Aggregated Column |
| [aggregation](https://www.adaptabletools.com/docs/reference/pivotaggregationtotalheadercontext.md#aggregation) | `string` | Aggregation function of Column |
| [columnType](https://www.adaptabletools.com/docs/reference/pivotaggregationtotalheadercontext.md#columntype) | `'pivotAggregationTotal'` | Pivot Aggregation Total Column |
| [pivotColumnId](https://www.adaptabletools.com/docs/reference/pivotaggregationtotalheadercontext.md#pivotcolumnid) | `string` | Id of Pivot Column |
| [pivotKey](https://www.adaptabletools.com/docs/reference/pivotaggregationtotalheadercontext.md#pivotkey) | `string` | Key (i.e. column value) of Pivot Column |
| [adaptableContext](https://www.adaptabletools.com/docs/reference/pivotaggregationtotalheadercontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` |

See [Adaptable Column](https://www.adaptabletools.com/docs/dev-guide-columns-adaptable-column/index.md) for the column object itself

-----------

## Column API

| Method | Returns | Description |
| --- | --- | --- |
| [addColumnsToSelection(columnIds)](https://www.adaptabletools.com/docs/reference/columnapi.md#addcolumnstoselection) | `void` | Adds (highlights) a group of Columns to any existing selection |
| [addColumnToSelection(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#addcolumntoselection) | `void` | Adds (highlights) a Column to any existing selection |
| [autosizeAllColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#autosizeallcolumns) | `void` | Autosizes all Columns in the Grid |
| [autosizeColumn(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#autosizecolumn) | `void` | AutoSizes a Column |
| [autosizeColumns(columnIds)](https://www.adaptabletools.com/docs/reference/columnapi.md#autosizecolumns) | `void` | Autosizes given Columns |
| [doesColumnExist(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#doescolumnexist) | `boolean` | Checks if Column has already been created |
| [getAdaptableDataTypeForCellDataType(cellDataType)](https://www.adaptabletools.com/docs/reference/columnapi.md#getadaptabledatatypeforcelldatatype) | [`AdaptableColumnDataType`](https://www.adaptabletools.com/docs/reference/adaptablecolumndatatype.md)` \| undefined` | Resolves the AdapTable `DataType` for an AG Grid `cellDataType` key<br/>(custom types map via `baseDataType` / `extendsDataType`). |
| [getAggregatableColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getaggregatablecolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all Aggregatable Columns |
| [getAGGridColDefForColumnId(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#getaggridcoldefforcolumnid) | `ColDef \| ColGroupDef` | Returns AG Grid ColDef for a given ColumnId |
| [getAGGridColumnForColumnId(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#getaggridcolumnforcolumnid) | `Column` | Returns the AG Grid Column for a given ColumnId |
| [getArrayColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getarraycolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all array columns (number, tuple-number, object-number &amp; text) |
| [getAvailableCellDataTypes()](https://www.adaptabletools.com/docs/reference/columnapi.md#getavailablecelldatatypes) | [`AvailableCellDataTypeInfo`](https://www.adaptabletools.com/docs/reference/availablecelldatatypeinfo.md)`[]` | Application-registered AG Grid cell data types (from the app&#39;s<br/>`dataTypeDefinitions`), for optional special-column Cell Data Type settings.<br/>Empty when the app has not registered custom types. Does not include<br/>AdapTable baselines (number / text / date / boolean / numberArray). |
| [getBooleanColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getbooleancolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all boolean Columns |
| [getColumnDataTypeForColumnId(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#getcolumndatatypeforcolumnid) | [`AdaptableColumnDataType`](https://www.adaptabletools.com/docs/reference/adaptablecolumndatatype.md)` \| undefined` | Returns Data Type for the Column with given ColumnId |
| [getColumnForColDef(colDef)](https://www.adaptabletools.com/docs/reference/columnapi.md#getcolumnforcoldef) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)` \| undefined` | Returns the AdapTable Column that maps to a given AG Grid ColDef<br/><br/>The ColDef is matched to a Column by `colId` (falling back to `field`), mirroring how AG Grid derives a Column&#39;s `colId` |
| [getColumnIdForFriendlyName(friendlyName)](https://www.adaptabletools.com/docs/reference/columnapi.md#getcolumnidforfriendlyname) | `string` | Retrieves ColumnId for Column with given Friendly Name |
| [getColumnIdsForFriendlyNames(friendlyNames)](https://www.adaptabletools.com/docs/reference/columnapi.md#getcolumnidsforfriendlynames) | `string[]` | Retrieves ColumnIds for Columns with given Friendly Names |
| [getColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getcolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all Columns available (including hidden, special) |
| [getColumnsByColumnType(columnType)](https://www.adaptabletools.com/docs/reference/columnapi.md#getcolumnsbycolumntype) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all columns of a given columnType |
| [getColumnSummaryForColumnId(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#getcolumnsummaryforcolumnid) | [`AdaptableColumnSummary`](https://www.adaptabletools.com/docs/reference/adaptablecolumnsummary.md) | Gets summary info for a column including filters and unique values |
| [getColumnsWithColumnIds(columnIds)](https://www.adaptabletools.com/docs/reference/columnapi.md#getcolumnswithcolumnids) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Retrieves Adaptable Columns with given ColumnIds |
| [getColumnsWithDataType(dataType)](https://www.adaptabletools.com/docs/reference/columnapi.md#getcolumnswithdatatype) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all Columns that have given DataType |
| [getColumnsWithFriendlyNames(friendlyNames)](https://www.adaptabletools.com/docs/reference/columnapi.md#getcolumnswithfriendlynames) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Retrieves Adaptable Columns with given Friendly names |
| [getColumnTypes()](https://www.adaptabletools.com/docs/reference/columnapi.md#getcolumntypes) | `string[]` | Returns available columns types defined under columnOptions.columnTypes |
| [getColumnWithColumnId(columnId, logWarning)](https://www.adaptabletools.com/docs/reference/columnapi.md#getcolumnwithcolumnid) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)` \| undefined` | Retrieves AdapTable Column with given ColumnId |
| [getColumnWithFriendlyName(columnName, logWarning)](https://www.adaptabletools.com/docs/reference/columnapi.md#getcolumnwithfriendlyname) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md) | Retrieves AdapTable Column with given Friendly name |
| [getDateColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getdatecolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all Date Columns |
| [getDefaultAggFunc(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#getdefaultaggfunc) | `string` | Returns the default Aggregation Function for a Column |
| [getExportableColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getexportablecolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all Exportable Columns |
| [getFilterableColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getfilterablecolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all Filterable Columns |
| [getFriendlyNameForColumnId(columnId, layout)](https://www.adaptabletools.com/docs/reference/columnapi.md#getfriendlynameforcolumnid) | `string` | Retrieves Friendly Name of Column with given ColumnId |
| [getFriendlyNamesForColumnIds(columnIds)](https://www.adaptabletools.com/docs/reference/columnapi.md#getfriendlynamesforcolumnids) | `string[]` | Retrieves Friendly Names for given ColumnIds |
| [getGroupableColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getgroupablecolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all Groupable Columns |
| [getNonSpecialColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getnonspecialcolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all UI available columns excluding Action, FreeText and Calculated Columns |
| [getNumberArrayColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getnumberarraycolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all number-array columns |
| [getNumericArrayColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getnumericarraycolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all numeric array columns (number, tuple-number, object-number) |
| [getNumericColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getnumericcolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all numeric Columns |
| [getObjectNumberArrayColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getobjectnumberarraycolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all object-number-array columns e.g. [x:1,y:2,x:3,y:4] |
| [getPivotableColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getpivotablecolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all Pivotable Columns |
| [getPrimaryKeyColumn()](https://www.adaptabletools.com/docs/reference/columnapi.md#getprimarykeycolumn) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)` \| undefined` | Retrieves current Primary Key Column in AdapTable. It may be undefined if the primary key is auto-generated, or it is NOT mapped to a column. |
| [getQueryableColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getqueryablecolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all Queryable Columns |
| [getRowGroupedColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getrowgroupedcolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all columns currently Row Grouped |
| [getSortableColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getsortablecolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all Sortable Columns |
| [getSpecialColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getspecialcolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns any Action, FreeText and Calculated Columns |
| [getTextArrayColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#gettextarraycolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all string array Columns |
| [getTextColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#gettextcolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all Text Columns |
| [getTupleNumberArrayColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#gettuplenumberarraycolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all tuple-number-array columns e.g. [[1,2],[3,4]] |
| [getUIAvailableColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getuiavailablecolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all Columns that can be displayed in UI (excludes always hidden cols) |
| [getUIHiddenColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getuihiddencolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns Columns that are always hidden in UI (but available for Expressions) |
| [getVisibleColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#getvisiblecolumns) | [`AdaptableColumn`](https://www.adaptabletools.com/docs/reference/adaptablecolumn.md)`[]` | Returns all visible Columns |
| [hasArrayDataType(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#hasarraydatatype) | `boolean` | Checks if the Column with the given `columnId` has any Array-like DataType (`TextArray`,`NumberArray`,`TupleNumberArray` or `ObjectNumberArray`) |
| [hasBooleanDataType(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#hasbooleandatatype) | `boolean` | Checks if the Column with the given `columnId` has DataType Boolean |
| [hasColumnType(columnIdentifier, columnType)](https://www.adaptabletools.com/docs/reference/columnapi.md#hascolumntype) | `boolean` | Checks if the Column with given Column Identifier (columnId or ColDef) has a specific Column Type |
| [hasDateDataType(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#hasdatedatatype) | `boolean` | Checks if the Column with the given `columnId` has DataType Date |
| [hasNumberDataType(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#hasnumberdatatype) | `boolean` | Checks if the Column with the given `columnId` has DataType Number |
| [hasNumericArrayDataType(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#hasnumericarraydatatype) | `boolean` | Checks if the Column with the given `columnId` has an Numeric Array-like DataType (`NumberArray`,`TupleNumberArray` or `ObjectNumberArray`) |
| [hasTextArrayDataType(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#hastextarraydatatype) | `boolean` | Checks if the Column with the given `columnId` has a Text Array-like DataType (`TextArray`) |
| [hideColumn(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#hidecolumn) | `void` | Hides a Column from Grid |
| [isActionColumn(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#isactioncolumn) | `boolean` | Checks if Column with given ColumnId is an Action Column |
| [isAgGridGeneratedColumn(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#isaggridgeneratedcolumn) | `boolean` | Whether column is auto generated by AG Grid (for selection, grouping, pivoting etc) |
| [isAutoRowGroupColumn(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#isautorowgroupcolumn) | `boolean` | Checks if Column with given ColumnId is a row-group Column automatically generated by AG Grid |
| [isAutoRowGroupColumnForMulti(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#isautorowgroupcolumnformulti) | `boolean` | Checks if Column with given ColumnId is a row-group Column automatically generated by AG Grid, for row-grouping with group display type = &#39;multi&#39; |
| [isAutoRowGroupColumnForSingle(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#isautorowgroupcolumnforsingle) | `boolean` | Checks if Column with given ColumnId is a row-group Column automatically generated by AG Grid, for row-grouping with group display type = &#39;single&#39; |
| [isCalculatedColumn(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#iscalculatedcolumn) | `boolean` | Checks if Column with given ColumnId is a Calculated Column |
| [isColumnInGrid(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#iscolumningrid) | `boolean` | Returns true if the given Column exists in the Grid |
| [isFdc3Column(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#isfdc3column) | `boolean` | Checks if Column with given ColumnId is a FDC3 Column |
| [isFreeTextColumn(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#isfreetextcolumn) | `boolean` | Checks if Column with given ColumnId is a Free Text Column |
| [isPivotAggColumnWithNoPivotColumns(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#ispivotaggcolumnwithnopivotcolumns) | `boolean` | Checks if Column with given ColumnId is a pivot aggregation column in a pivot layout with no pivot columns.<br/>When PivotColumns is empty, aggregation columns keep their original IDs instead of getting a &#39;pivot_&#39; prefix. |
| [isPivotResultColumn(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#ispivotresultcolumn) | `boolean` | Checks if Column with given ColumnId is a pivot Column automatically generated by AG Grid |
| [isSelectionColumn(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#isselectioncolumn) | `boolean` | Checks if Column with given ColumnId is a Selection (Checkbox) Column automatically generated by AG Grid |
| [isSpecialColumn(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#isspecialcolumn) | `boolean` | Checks if Column with given ColumnId is a Special (i.e. calculated, freetext or action) Column |
| [openColumnInfoSettingsPanel(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#opencolumninfosettingspanel) | `void` | Opens Settings Panel with Column Info section selected and visible |
| [selectAllColumns()](https://www.adaptabletools.com/docs/reference/columnapi.md#selectallcolumns) | `void` | Selects all Columns |
| [selectColumn(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#selectcolumn) | `void` | Selects (highlights) a Column |
| [selectColumns(columnIds)](https://www.adaptabletools.com/docs/reference/columnapi.md#selectcolumns) | `void` | Selects (highlights) group of Columns |
| [setColumnCaption(columnId, caption)](https://www.adaptabletools.com/docs/reference/columnapi.md#setcolumncaption) | `void` | Sets a new Caption / Header for a Column (only for current Layout) |
| [showColumn(columnId)](https://www.adaptabletools.com/docs/reference/columnapi.md#showcolumn) | `void` | Makes a Column visible |