AdapTable Types Reference

ColumnOptions

Options related to managing Columns in Adaptable.

TypeScript
export interface

Properties

PropertyDescriptionDefault
addColumnGroupToColumnFriendlyNameAppends the name of the Column Group to a Column's Friendly Namefalse
columnFriendlyNameProvide an alternative Friendly Name for a Columnundefined
columnHeaderProvide a custom Header Name for a Table or Pivot Column
columnTypesOptional list of Column Types - used for Scope and creating Special ColumnsEmpty Array
showMissingColumnsWarningLog warning to console if AdapTable cannot find a columntrue

Property Details

addColumnGroupToColumnFriendlyName

Appends the name of the Column Group to a Column's Friendly Name

TypeScript
addColumnGroupToColumnFriendlyName?: boolean;
Default Value

false

Property Value

boolean

columnFriendlyName

Provide an alternative Friendly Name for a Column

TypeScript
columnFriendlyName?: (columnFriendlyNameContext: ColumnFriendlyNameContext) => string | undefined;
Default Value

undefined

Property Value

(columnFriendlyNameContext:ColumnFriendlyNameContext) => string | undefined

columnHeader

Provide a custom Header Name for a Table or Pivot Column

TypeScript
columnHeader?: (context: ColumnHeaderContext) => string;
Property Value

(context:ColumnHeaderContext) => string

columnTypes

Optional list of Column Types - used for Scope and creating Special Columns

TypeScript
columnTypes?: TypeHint<string, AdaptableColumnTypeName>[] | ((context: ColumnTypesContext) => TypeHint<string, AdaptableColumnTypeName>[]);
Default Value

Empty Array

Property Value

TypeHint<string,AdaptableColumnTypeName>[] | ((context:ColumnTypesContext) => TypeHint<string,AdaptableColumnTypeName>[])

showMissingColumnsWarning

Log warning to console if AdapTable cannot find a column

TypeScript
showMissingColumnsWarning?: boolean;
Default Value

true

Property Value

boolean

PreviousColumnNumberMapNextColumnScope