AdaptableColumn
Defines an AdapTable Column - created at run-time based on AG Grid ColDef
export interface AdaptableColumn<TData = any> extendsExtends
Properties
| Property | Description |
|---|---|
| aggregatable | Is Column able to display aggregations (e.g. 'sum') when grouped |
| aggregationFunction | Custom Aggregation function for the Column |
| availableAggregationFunctions | Available Aggregations for the Column |
| columnGroup | The parent Column group (if Column belongs to one) |
| exportable | Whether the Column can be included in Reports |
| field | Field in the row to get cell data from |
| fieldOnly | Is the Column ONLY available as a field and never visible |
| filterable | Is Column able to be filtered |
| flex | Flex details of the Column |
| groupable | Can Column form a Row Group |
| hideable | Can Column be removed from the grid |
| isActionColumn | Is Column an Action Column |
| isCalculatedColumn | Is Column a Calculated Column |
| isFixed | Is Column pinned or locked into position |
| isFreeTextColumn | Is Column a Free Text Column |
| isGeneratedPivotResultColumn | Is Column a generated Pivot Result Column |
| isGeneratedRowGroupColumn | Is Column a generated Row Group Column |
| isGeneratedSelectionColumn | Is Column a generated Selection Column |
| isGrouped | Is Column currently Row-Grouped |
| isPivotTotalColumn | Is Column a Pivot Total Column (GrandTotal, GroupTotal, AggregationTotal) |
| isPrimaryKey | Is this the Primary Key Column |
| isSparkline | Is it a Sparkline Column |
| isTreeColumn | Whether Column is the Tree Column (in Tree View) |
| isUIHiddenColumn | Whether Column is always hidden in UI but still available programmatically |
| moveable | Can Column be moved at run-time to a new position |
| pinned | The pinned position of the Column |
| pivotable | Can Column be used in a Pivot Layout |
| queryable | Can the Column be in included in Queries / Expressions |
| readOnly | Is Column editable; returns FALSE if Column has conditional/dynamic editability, assuming some rows are editable |
| resizable | Is Column resizable |
| sortable | Is Column sortable |
| visible | Is Column currently visible |
| width | Column width |
| IsReadOnly | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
Property Details
aggregatable
Is Column able to display aggregations (e.g. 'sum') when grouped
aggregatable: boolean;Property Value
boolean
aggregationFunction
Custom Aggregation function for the Column
aggregationFunction?: string;Property Value
string
availableAggregationFunctions
Available Aggregations for the Column
availableAggregationFunctions?: string[];Property Value
string[]
columnGroup
The parent Column group (if Column belongs to one)
columnGroup?: AdaptableColumnGroup;Property Value
exportable
Whether the Column can be included in Reports
exportable: boolean;Property Value
boolean
field
Field in the row to get cell data from
field?: Extract<keyof TData, string>;Property Value
Extract<keyof TData, string>
fieldOnly
Is the Column ONLY available as a field and never visible
fieldOnly: boolean;Property Value
boolean
filterable
Is Column able to be filtered
filterable: boolean;Property Value
boolean
flex
Flex details of the Column
flex?: number;Property Value
number
groupable
Can Column form a Row Group
groupable: boolean;Property Value
boolean
hideable
Can Column be removed from the grid
hideable: boolean;Property Value
boolean
isActionColumn
Is Column an Action Column
isActionColumn: boolean;Property Value
boolean
isCalculatedColumn
Is Column a Calculated Column
isCalculatedColumn: boolean;Property Value
boolean
isFixed
Is Column pinned or locked into position
isFixed: boolean;Property Value
boolean
isFreeTextColumn
Is Column a Free Text Column
isFreeTextColumn: boolean;Property Value
boolean
isGeneratedPivotResultColumn
Is Column a generated Pivot Result Column
isGeneratedPivotResultColumn: boolean;Property Value
boolean
isGeneratedRowGroupColumn
Is Column a generated Row Group Column
isGeneratedRowGroupColumn: boolean;Property Value
boolean
isGeneratedSelectionColumn
Is Column a generated Selection Column
isGeneratedSelectionColumn: boolean;Property Value
boolean
isGrouped
Is Column currently Row-Grouped
isGrouped: boolean;Property Value
boolean
isPivotTotalColumn
Is Column a Pivot Total Column (GrandTotal, GroupTotal, AggregationTotal)
isPivotTotalColumn: boolean;Property Value
boolean
isPrimaryKey
Is this the Primary Key Column
isPrimaryKey: boolean;Property Value
boolean
isSparkline
Is it a Sparkline Column
isSparkline: boolean;Property Value
boolean
isTreeColumn
Whether Column is the Tree Column (in Tree View)
isTreeColumn: boolean;Property Value
boolean
isUIHiddenColumn
Whether Column is always hidden in UI but still available programmatically
isUIHiddenColumn: boolean;Property Value
boolean
moveable
Can Column be moved at run-time to a new position
moveable: boolean;Property Value
boolean
pinned
The pinned position of the Column
pinned: 'left' | 'right' | false;Property Value
'left' | 'right' | false
pivotable
Can Column be used in a Pivot Layout
pivotable: boolean;Property Value
boolean
queryable
Can the Column be in included in Queries / Expressions
queryable: boolean;Property Value
boolean
readOnly
Is Column editable; returns FALSE if Column has conditional/dynamic editability, assuming some rows are editable
readOnly: boolean;Property Value
boolean
resizable
Is Column resizable
resizable: boolean;Property Value
boolean
sortable
Is Column sortable
sortable: boolean;Property Value
boolean
visible
Is Column currently visible
visible: boolean;Property Value
boolean
width
Column width
width?: number;Property Value
number
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsReadOnly?: boolean;Property Value
boolean