Column Technical Reference
Column Options
This class includes an option to show a warning if it cannot find a provided Column.
showMissingColumnsWarning
Default: trueBooleanColumnOptions
Options related to managing Columns in Adaptable.
Appends the name of the Column Group to a Column's Friendly Name
false
(columnFriendlyNameContext:ColumnFriendlyNameContext) => string | undefined
Provide an alternative Friendly Name for a Column
undefined
(context:ColumnHeaderContext) => string
Provide a custom Header Name for a Table or Pivot Column.
Always invoked when provided, including when the current Layout has a
caption for the Column. Use layoutSpecificHeaderName on the context to
honour a user override, colDefHeaderName for the AG Grid header, or
return your own value.
TypeHint<string,AdaptableColumnTypeName>[] | ((context:ColumnTypesContext) => TypeHint<string,AdaptableColumnTypeName>[])
Optional list of Column Types - used for Scope and creating Special Columns
Empty Array
boolean
Log warning to console if AdapTable cannot find a column
true
columnTypes entries are an AdaptableColumnTypeName:
| Value |
|---|
'hiddenColumn' |
'calculatedColumn' |
'freeTextColumn' |
'actionColumn' |
'fdc3Column' |
'pivotAnyTotal' |
'pivotGrandTotal' |
'pivotColumnTotal' |
'pivotAggregationTotal' |
columnFriendlyName receives a ColumnFriendlyNameContext:
ColumnFriendlyNameContext
Context used when setting a Column Friendly Name
Column
AG Grid ColDef for the Column
string
Id of the Column
Column Group Information
string
AG Grid Display Name
Custom application Context provided in AdaptableOptions.adaptableContext
columnHeader receives a ColumnHeaderContext. The context is one of:
TableColumnHeaderContext
Context for standard Table Layout Columns
string
Aggregation function of Column (optional)
string
Id of the Column
'tableColumn'
Table Column (created in Table Layouts)
Custom application Context provided in AdaptableOptions.adaptableContext
TableColumnGroupHeaderContext
Context for Column Group headers
string[]
Ids of Column Group's children
'tableColumnGroup'
Table Column Group (used when Column Grouping in Table Layouts)
string
Id of Column Group
'expanded' | 'collapsed'
Expanded / Collapsed state of Column Group
Custom application Context provided in AdaptableOptions.adaptableContext
AutoGroupColumnHeaderContext
Context for Columns created automatically by AG Grid when Row Grouping
string
Id of the Column
'autoGroupColumn'
Auto-generated Row Group Column (when RowGroupDisplayType is single)
string[]
Ids of all Row Grouped Columns
Custom application Context provided in AdaptableOptions.adaptableContext
RowGroupColumnHeaderContext
Context for Columns created when Row Grouping
string
Id of the Column
'rowGroupColumn'
A Row Grouped Column (created in both Table and Pivot Layout)
string
Id of Row Grouped Column
Custom application Context provided in AdaptableOptions.adaptableContext
PivotColumnGroupHeaderContext
Context for Pivot Column Groups
'pivotColumnGroup'
Pivot Column Group (created for each distinct value in a PivotColumn)
string
Id of generated Column Group
string[]
Pivot Keys for Column Group
'expanded' | 'collapsed'
Expanded / Collapsed state of Column Group
Custom application Context provided in AdaptableOptions.adaptableContext
PivotResultColumnHeaderContext
Context for Pivot Result Columns
string
Id of Pivot Aggregated Column
string
Aggregation function of Column
string
Id of generated Column
'pivotResultColumn'
Pivot Result Column (unique intersection of PivotAggregationColumn and PivotColumn)
string[]
Current Pivot Keys
Custom application Context provided in AdaptableOptions.adaptableContext
PivotGrandTotalHeaderContext
Context for Pivot Grand Total Columns
string
Id of Pivot Aggregated Column
string
Aggregation function of Column
'pivotGrandTotal'
Pivot Grand Total Column
Custom application Context provided in AdaptableOptions.adaptableContext
PivotColumnTotalHeaderContext
Context for Pivot Total Columns
string
Aggregation function of Column
'pivotColumnTotal'
Pivot Column Total
string
Id of Pivot Column
string
Key (i.e. column value) of Pivot Column
Custom application Context provided in AdaptableOptions.adaptableContext
PivotAggregationTotalHeaderContext
Context for Pivot Aggregation Totals
string
Id of Aggregated Column
string
Aggregation function of Column
'pivotAggregationTotal'
Pivot Aggregation Total Column
string
Id of Pivot Column
string
Key (i.e. column value) of Pivot Column
Custom application Context provided in AdaptableOptions.adaptableContext
Find Out More
See Adaptable Column for the column object itself
Column API
ColumnApi
Columns in the grid: lookup by id or friendly name, data type, visibility and which columns can be sorted, filtered, grouped or exported.
void
Adds (highlights) a group of Columns to any existing selection
void
Adds (highlights) a Column to any existing selection
void
Autosizes all Columns in the Grid
void
AutoSizes a Column
void
Autosizes given Columns
boolean
Checks if Column has already been created
AdaptableColumnDataType | undefined
Resolves the AdapTable DataType for an AG Grid cellDataType key
(custom types map via baseDataType / extendsDataType).
Returns all Aggregatable Columns
ColDef | ColGroupDef
Returns AG Grid ColDef for a given ColumnId
Column
Returns the AG Grid Column for a given ColumnId
Returns all array columns (number, tuple-number, object-number & text)
Application-registered AG Grid cell data types (from the app'sdataTypeDefinitions), for optional special-column Cell Data Type settings.
Empty when the app has not registered custom types. Does not include
AdapTable baselines (number / text / date / boolean / numberArray).
Returns all boolean Columns
AdaptableColumnDataType | undefined
Returns Data Type for the Column with given ColumnId
AdaptableColumn | undefined
Returns the AdapTable Column that maps to a given AG Grid ColDef
The ColDef is matched to a Column by colId (falling back to field), mirroring how AG Grid derives a Column's colId
string
Retrieves ColumnId for Column with given Friendly Name
string[]
Retrieves ColumnIds for Columns with given Friendly Names
Returns all Columns available (including hidden, special)
Returns all columns of a given columnType
Gets summary info for a column including filters and unique values
Retrieves Adaptable Columns with given ColumnIds
Returns all Columns that have given DataType
Retrieves Adaptable Columns with given Friendly names
string[]
Returns available columns types defined under columnOptions.columnTypes
AdaptableColumn | undefined
Retrieves AdapTable Column with given ColumnId
Retrieves AdapTable Column with given Friendly name
Returns all Date Columns
string
Returns the default Aggregation Function for a Column
Returns all Exportable Columns
Returns all Filterable Columns
string
Retrieves Friendly Name of Column with given ColumnId
string[]
Retrieves Friendly Names for given ColumnIds
Returns all Groupable Columns
Returns all UI available columns excluding Action, FreeText and Calculated Columns
Returns all number-array columns
Returns all numeric array columns (number, tuple-number, object-number)
Returns all numeric Columns
Returns all object-number-array columns e.g. [x:1,y:2,x:3,y:4]
Returns all Pivotable Columns
AdaptableColumn | 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.
Returns all Queryable Columns
Returns all columns currently Row Grouped
Returns all Sortable Columns
Returns any Action, FreeText and Calculated Columns
Returns all string array Columns
Returns all Text Columns
Returns all tuple-number-array columns e.g. [[1,2],[3,4]]
Returns all Columns that can be displayed in UI (excludes always hidden cols)
Returns all visible Columns
boolean
Checks if the Column with the given columnId has any Array-like DataType (TextArray,NumberArray,TupleNumberArray or ObjectNumberArray)
boolean
Checks if the Column with the given columnId has DataType Boolean
boolean
Checks if the Column with given Column Identifier (columnId or ColDef) has a specific Column Type
boolean
Checks if the Column with the given columnId has DataType Date
boolean
Checks if the Column with the given columnId has DataType Number
boolean
Checks if the Column with the given columnId has an Numeric Array-like DataType (NumberArray,TupleNumberArray or ObjectNumberArray)
boolean
Checks if the Column with the given columnId has a Text Array-like DataType (TextArray)
void
Hides a Column from Grid
boolean
Checks if Column with given ColumnId is an Action Column
boolean
Whether column is auto generated by AG Grid (for selection, grouping, pivoting etc)
boolean
Checks if Column with given ColumnId is a row-group Column automatically generated by AG Grid
boolean
Checks if Column with given ColumnId is a row-group Column automatically generated by AG Grid, for row-grouping with group display type = 'multi'
boolean
Checks if Column with given ColumnId is a row-group Column automatically generated by AG Grid, for row-grouping with group display type = 'single'
boolean
Checks if Column with given ColumnId is a Calculated Column
boolean
Returns true if the given Column exists in the Grid
boolean
Checks if Column with given ColumnId is a FDC3 Column
boolean
Checks if Column with given ColumnId is a Free Text Column
boolean
Checks if Column with given ColumnId is a pivot aggregation column in a pivot layout with no pivot columns.
When PivotColumns is empty, aggregation columns keep their original IDs instead of getting a 'pivot_' prefix.
boolean
Checks if Column with given ColumnId is a pivot Column automatically generated by AG Grid
boolean
Checks if Column with given ColumnId is a Selection (Checkbox) Column automatically generated by AG Grid
boolean
Checks if Column with given ColumnId is a Special (i.e. calculated, freetext or action) Column
void
Opens Settings Panel with Column Info section selected and visible
void
Selects all Columns
void
Selects (highlights) a Column
void
Selects (highlights) group of Columns
void
Sets a new Caption / Header for a Column (only for current Layout)
void
Makes a Column visible