SpecialColumnSettings
Base Settings for both Calculated and FreeText Columns
export interfaceProperties
| Property | Type | Description | Default |
|---|---|---|---|
| Aggregatable | boolean | Whether Column can be used in an aggregation when grouping | false |
| ColumnTypes | string[] | Custom column types added to AG Grid Column Types when object is created | |
| DataType | AdaptableColumnDataType | Expression's return value DataType, only mandatory property | |
| Filterable | boolean | Whether Column is filterable | false |
| Groupable | boolean | Whether Column can be grouped | false |
| HeaderToolTip | string | Tooltip to show in the Column Header (not cells) | |
| Pivotable | boolean | Whether Column can be used when grid is in pivot mode | false |
| Resizable | boolean | Whether Column can be resized (by dragging column header edges) | false |
| Sortable | boolean | Whether Column is sortable | false |
| SuppressMenu | boolean | Whether if no menu should be shown for this Column header. | false |
| SuppressMovable | boolean | Whether if this Column should be movable via dragging | false |
| Width | number | Preferred (pixel) Column Width; if unset, calculated dynamically by AG Grid |
Property Details
Aggregatable
Whether Column can be used in an aggregation when grouping
Aggregatable?: boolean;Default Value
false
Property Value
boolean
ColumnTypes
Custom column types added to AG Grid Column Types when object is created
ColumnTypes?: string[];Property Value
string[]
DataType
Expression's return value DataType, only mandatory property
DataType: AdaptableColumnDataType;Property Value
Filterable
Whether Column is filterable
Filterable?: boolean;Default Value
false
Property Value
boolean
Groupable
Whether Column can be grouped
Groupable?: boolean;Default Value
false
Property Value
boolean
HeaderToolTip
Tooltip to show in the Column Header (not cells)
HeaderToolTip?: string;Property Value
string
Pivotable
Whether Column can be used when grid is in pivot mode
Pivotable?: boolean;Default Value
false
Property Value
boolean
Resizable
Whether Column can be resized (by dragging column header edges)
Resizable?: boolean;Default Value
false
Property Value
boolean
Sortable
Whether Column is sortable
Sortable?: boolean;Default Value
false
Property Value
boolean
SuppressMenu
Whether if no menu should be shown for this Column header.
SuppressMenu?: boolean;Default Value
false
Property Value
boolean
SuppressMovable
Whether if this Column should be movable via dragging
SuppressMovable?: boolean;Default Value
false
Property Value
boolean
Width
Preferred (pixel) Column Width; if unset, calculated dynamically by AG Grid
Width?: number;Property Value
number