ColumnApi

Provides run-time access to AdapTable Column related features

export interface

Methods

Method Details

addColumnsToSelection

Adds (highlights) a group of Columns to any existing selection

addColumnsToSelection(columnIds: string[]): void;

Parameters

Returns

void

addColumnToSelection

Adds (highlights) a Column to any existing selection

addColumnToSelection(columnId: string): void;

Parameters

Returns

void

autosizeAllColumns

Autosizes all Columns in the Grid

autosizeAllColumns(): void;

Returns

void

autosizeColumn

AutoSizes a Column

autosizeColumn(columnId: string): void;

Parameters

Returns

void

autosizeColumns

Autosizes given Columns

autosizeColumns(columnIds: string[]): void;

Parameters

Returns

void

doesColumnExist

Checks if Column has already been created

doesColumnExist(columnId: string): boolean;

Parameters

Returns

boolean

getAggregatableColumns

Returns all Aggregatable Columns

getAggregatableColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getAGGridColDefForColumnId

Returns AG Grid ColDef for a given ColumnId

getAGGridColDefForColumnId(columnId: string): ColDef | ColGroupDef;

Parameters

Returns

ColDef | ColGroupDef

getAGGridColumnForColumnId

Returns the AG Grid Column for a given ColumnId

getAGGridColumnForColumnId(columnId: string): Column;

Parameters

Returns

Column

getArrayColumns

Returns all array columns (number, tuple-number, object-number & text)

getArrayColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getBooleanColumns

Returns all boolean Columns

getBooleanColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getColumnDataTypeForColumnId

Returns Data Type for the Column with given ColumnId

getColumnDataTypeForColumnId(columnId: string): AdaptableColumnDataType | undefined;

Parameters

Returns

AdaptableColumnDataType | undefined

getColumnIdForFriendlyName

Retrieves ColumnId for Column with given Friendly Name

getColumnIdForFriendlyName(friendlyName: string): string;

Parameters

Returns

string

getColumnIdsForFriendlyNames

Retrieves ColumnIds for Columns with given Friendly Names

getColumnIdsForFriendlyNames(friendlyNames: string[]): string[];

Parameters

Returns

string[]

getColumns

Returns all Columns available (including hidden, special)

getColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getColumnsByColumnType

Returns all columns of a given columnType

getColumnsByColumnType(columnType: string): AdaptableColumn[];

Parameters

Returns

AdaptableColumn[]

getColumnSummaryForColumnId

Gets summary info for a column including filters and unique values

getColumnSummaryForColumnId(columnId: string): AdaptableColumnSummary;

Parameters

Returns

AdaptableColumnSummary

getColumnsWithColumnIds

Retrieves Adaptable Columns with given ColumnIds

getColumnsWithColumnIds(columnIds: string[]): AdaptableColumn[];

Parameters

Returns

AdaptableColumn[]

getColumnsWithDataType

Returns all Columns that have given DataType

getColumnsWithDataType(dataType: AdaptableColumnDataType): AdaptableColumn[];

Parameters

Returns

AdaptableColumn[]

getColumnsWithFriendlyNames

Retrieves Adaptable Columns with given Friendly names

getColumnsWithFriendlyNames(friendlyNames: string[]): AdaptableColumn[];

Parameters

Returns

AdaptableColumn[]

getColumnTypes

Returns available columns types defined under columnOptions.columnTypes

getColumnTypes(): string[];

Returns

string[]

getColumnWithColumnId

Retrieves AdapTable Column with given ColumnId

getColumnWithColumnId(columnId: string, logWarning?: boolean): AdaptableColumn | undefined;

Parameters

Returns

AdaptableColumn | undefined

getColumnWithFriendlyName

Retrieves AdapTable Column with given Friendly name

getColumnWithFriendlyName(columnName: string, logWarning?: boolean): AdaptableColumn;

Parameters

Returns

AdaptableColumn

getDateColumns

Returns all Date Columns

getDateColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getDefaultAggFunc

Returns the default Aggregation Function for a Column

getDefaultAggFunc(columnId: string): string;

Parameters

Returns

string

getExportableColumns

Returns all Exportable Columns

getExportableColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getFilterableColumns

Returns all Sortable Columns

getFilterableColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getFriendlyNameForColumnId

Retrieves Friendly Name of Column with given ColumnId

getFriendlyNameForColumnId(columnId: string, layout?: Layout): string;

Parameters

Returns

string

getFriendlyNamesForColumnIds

Retrieves Friendly Names for given ColumnIds

getFriendlyNamesForColumnIds(columnIds: string[]): string[];

Parameters

Returns

string[]

getGroupableColumns

Returns all Groupable Columns

getGroupableColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getNonSpecialColumns

Returns all UI available columns excluding Action, FreeText and Calculated Columns

getNonSpecialColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getNumberArrayColumns

Returns all number-array columns

getNumberArrayColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getNumericArrayColumns

Returns all numeric array columns (number, tuple-number, object-number)

getNumericArrayColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getNumericColumns

Returns all numeric Columns

getNumericColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getObjectNumberArrayColumns

Returns all object-number-array columns e.g. [x:1,y:2,x:3,y:4]

getObjectNumberArrayColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getPivotableColumns

Returns all Pivotable Columns

getPivotableColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getPrimaryKeyColumn

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.

getPrimaryKeyColumn(): AdaptableColumn | undefined;

Returns

AdaptableColumn | undefined

getQueryableColumns

Returns all Queryable Columns

getQueryableColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getRowGroupedColumns

Returns all columns currently Row Grouped

getRowGroupedColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getSortableColumns

Returns all Sortable Columns

getSortableColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getSpecialColumns

Returns any Action, FreeText and Calculated Columns

getSpecialColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getTextArrayColumns

Returns all string array Columns

getTextArrayColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getTextColumns

Returns all Text Columns

getTextColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getTupleNumberArrayColumns

Returns all tuple-number-array columns e.g. [[1,2],[3,4]]

getTupleNumberArrayColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getUIAvailableColumns

Returns all Columns that can be displayed in UI (excludes always hidden cols)

getUIAvailableColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getUIHiddenColumns

Returns Columns that are always hidden in UI (but available for Expressions)

getUIHiddenColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

getVisibleColumns

Returns all visible Columns

getVisibleColumns(): AdaptableColumn[];

Returns

AdaptableColumn[]

hasArrayDataType

Checks if the Column with the given columnId has any Array-like DataType (TextArray,NumberArray,TupleNumberArray or ObjectNumberArray)

hasArrayDataType(columnId: string): boolean;

Parameters

Returns

boolean

hasBooleanDataType

Checks if the Column with the given columnId has DataType Boolean

hasBooleanDataType(columnId: string): boolean;

Parameters

Returns

boolean

hasColumnType

Checks if the Column with given Column Identifier (columnId or ColDef) has a specific Column Type

hasColumnType(columnIdentifier: string | ColDef, columnType: string): boolean;

Parameters

Returns

boolean

hasDateDataType

Checks if the Column with the given columnId has DataType Date

hasDateDataType(columnId: string): boolean;

Parameters

Returns

boolean

hasNumberDataType

Checks if the Column with the given columnId has DataType Number

hasNumberDataType(columnId: string): boolean;

Parameters

Returns

boolean

hasNumericArrayDataType

Checks if the Column with the given columnId has an Numeric Array-like DataType (NumberArray,TupleNumberArray or ObjectNumberArray)

hasNumericArrayDataType(columnId: string): boolean;

Parameters

Returns

boolean

hasTextArrayDataType

Checks if the Column with the given columnId has a Text Array-like DataType (TextArray)

hasTextArrayDataType(columnId: string): boolean;

Parameters

Returns

boolean

hideColumn

Hides a Column from Grid

hideColumn(columnId: string): void;

Parameters

Returns

void

isActionColumn

Checks if Column with given ColumnId is an Action Column

isActionColumn(columnId: string): boolean;

Parameters

Returns

boolean

isAgGridGeneratedColumn

Whether column is auto generated by AG Grid (for selection, grouping, pivoting etc)

isAgGridGeneratedColumn(columnId: string): boolean;

Parameters

Returns

boolean

isAutoRowGroupColumn

Checks if Column with given ColumnId is a row-group Column automatically generated by AG Grid

isAutoRowGroupColumn(columnId: string): boolean;

Parameters

Returns

boolean

isAutoRowGroupColumnForMulti

Checks if Column with given ColumnId is a row-group Column automatically generated by AG Grid, for row-grouping with group display type = 'multi'

isAutoRowGroupColumnForMulti(columnId: string): boolean;

Parameters

Returns

boolean

isAutoRowGroupColumnForSingle

Checks if Column with given ColumnId is a row-group Column automatically generated by AG Grid, for row-grouping with group display type = 'single'

isAutoRowGroupColumnForSingle(columnId: string): boolean;

Parameters

Returns

boolean

isCalculatedColumn

Checks if Column with given ColumnId is a Calculated Column

isCalculatedColumn(columnId: string): boolean;

Parameters

Returns

boolean

isColumnInGrid

Returns true if the given Column exists in the Grid

isColumnInGrid(columnId: string): boolean;

Parameters

Returns

boolean

isFdc3Column

Checks if Column with given ColumnId is a FDC3 Column

isFdc3Column(columnId: string): boolean;

Parameters

Returns

boolean

isFreeTextColumn

Checks if Column with given ColumnId is a Free Text Column

isFreeTextColumn(columnId: string): boolean;

Parameters

Returns

boolean

isPivotAggColumnWithNoPivotColumns

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.

isPivotAggColumnWithNoPivotColumns(columnId: string): boolean;

Parameters

Returns

boolean

isPivotResultColumn

Checks if Column with given ColumnId is a pivot Column automatically generated by AG Grid

isPivotResultColumn(columnId: string): boolean;

Parameters

Returns

boolean

isSelectionColumn

Checks if Column with given ColumnId is a Selection (Checkbox) Column automatically generated by AG Grid

isSelectionColumn(columnId: string): boolean;

Parameters

Returns

boolean

isSpecialColumn

Checks if Column with given ColumnId is a Special (i.e. calculated, freetext or action) Column

isSpecialColumn(columnId: string): boolean;

Parameters

Returns

boolean

openColumnInfoSettingsPanel

Opens Settings Panel with Column Info section selected and visible

openColumnInfoSettingsPanel(): void;

Returns

void

selectAllColumns

Selects all Columns

selectAllColumns(): void;

Returns

void

selectColumn

Selects (highlights) a Column

selectColumn(columnId: string): void;

Parameters

Returns

void

selectColumns

Selects (highlights) group of Columns

selectColumns(columnIds: string[]): void;

Parameters

Returns

void

setColumnCaption

Sets a new Caption / Header for a Column (only for current Layout)

setColumnCaption(columnId: string, caption: string): void;

Parameters

Returns

void

showColumn

Makes a Column visible

showColumn(columnId: string): void;

Parameters

Returns

void