SpecialColumnSettings

Base Settings for both Calculated and FreeText Columns

TypeScript
export interface

Properties

PropertyDescriptionDefault
AggregatableWhether Column can be used in an aggregation when groupingfalse
ColumnTypesCustom column types added to AG Grid Column Types when object is created
DataTypeExpression's return value DataType, only mandatory property
FilterableWhether Column is filterablefalse
GroupableWhether Column can be groupedfalse
HeaderToolTipTooltip to show in the Column Header (not cells)
PivotableWhether Column can be used when grid is in pivot modefalse
ResizableWhether Column can be resized (by dragging column header edges)false
SortableWhether Column is sortablefalse
SuppressMenuWhether if no menu should be shown for this Column header.false
SuppressMovableWhether if this Column should be movable via draggingfalse
WidthPreferred (pixel) Column Width; if unset, calculated dynamically by AG Grid

Property Details

Aggregatable

Whether Column can be used in an aggregation when grouping

TypeScript
Aggregatable?: boolean;
Default Value

false

Property Value

boolean

ColumnTypes

Custom column types added to AG Grid Column Types when object is created

TypeScript
ColumnTypes?: string[];
Property Value

string[]

DataType

Expression's return value DataType, only mandatory property

TypeScript
DataType: AdaptableColumnDataType;
Property Value

AdaptableColumnDataType

Filterable

Whether Column is filterable

TypeScript
Filterable?: boolean;
Default Value

false

Property Value

boolean

Groupable

Whether Column can be grouped

TypeScript
Groupable?: boolean;
Default Value

false

Property Value

boolean

HeaderToolTip

Tooltip to show in the Column Header (not cells)

TypeScript
HeaderToolTip?: string;
Property Value

string

Pivotable

Whether Column can be used when grid is in pivot mode

TypeScript
Pivotable?: boolean;
Default Value

false

Property Value

boolean

Resizable

Whether Column can be resized (by dragging column header edges)

TypeScript
Resizable?: boolean;
Default Value

false

Property Value

boolean

Sortable

Whether Column is sortable

TypeScript
Sortable?: boolean;
Default Value

false

Property Value

boolean

SuppressMenu

Whether if no menu should be shown for this Column header.

TypeScript
SuppressMenu?: boolean;
Default Value

false

Property Value

boolean

SuppressMovable

Whether if this Column should be movable via dragging

TypeScript
SuppressMovable?: boolean;
Default Value

false

Property Value

boolean

Width

Preferred (pixel) Column Width; if unset, calculated dynamically by AG Grid

TypeScript
Width?: number;
Property Value

number