AdaptableColumn

Defines an AdapTable Column - created at run-time based on AG Grid ColDef

TypeScript

export interface AdaptableColumn<TData = any> extends

Extends

AdaptableColumnBase

Properties

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

Property Details

aggregatable

Is Column able to display aggregations (e.g. 'sum') when grouped

TypeScript

aggregatable: boolean;

Property Value

boolean

aggregationFunction

Custom Aggregation function for the Column

TypeScript

aggregationFunction?: string;

Property Value

string

availableAggregationFunctions

Available Aggregations for the Column

TypeScript

availableAggregationFunctions?: string[];

Property Value

string[]

columnGroup

The parent Column group (if Column belongs to one)

TypeScript

columnGroup?: AdaptableColumnGroup;

Property Value

AdaptableColumnGroup

exportable

Whether the Column can be included in Reports

TypeScript

exportable: boolean;

Property Value

boolean

field

Field in the row to get cell data from

TypeScript

field?: Extract<keyof TData, string>;

Property Value

Extract<keyof TData, string>

fieldOnly

Is the Column ONLY available as a field and never visible

TypeScript

fieldOnly: boolean;

Property Value

boolean

filterable

Is Column able to be filtered

TypeScript

filterable: boolean;

Property Value

boolean

flex

Flex details of the Column

TypeScript

flex?: number;

Property Value

number

groupable

Can Column form a Row Group

TypeScript

groupable: boolean;

Property Value

boolean

hideable

Can Column be removed from the grid

TypeScript

hideable: boolean;

Property Value

boolean

isActionColumn

Is Column an Action Column

TypeScript

isActionColumn: boolean;

Property Value

boolean

isCalculatedColumn

Is Column a Calculated Column

TypeScript

isCalculatedColumn: boolean;

Property Value

boolean

isFixed

Is Column pinned or locked into position

TypeScript

isFixed: boolean;

Property Value

boolean

isFreeTextColumn

Is Column a Free Text Column

TypeScript

isFreeTextColumn: boolean;

Property Value

boolean

isGeneratedPivotResultColumn

Is Column a generated Pivot Result Column

TypeScript

isGeneratedPivotResultColumn: boolean;

Property Value

boolean

isGeneratedRowGroupColumn

Is Column a generated Row Group Column

TypeScript

isGeneratedRowGroupColumn: boolean;

Property Value

boolean

isGeneratedSelectionColumn

Is Column a generated Selection Column

TypeScript

isGeneratedSelectionColumn: boolean;

Property Value

boolean

isGrouped

Is Column currently Row-Grouped

TypeScript

isGrouped: boolean;

Property Value

boolean

isPivotTotalColumn

Is Column a Pivot Total Column (GrandTotal, GroupTotal, AggregationTotal)

TypeScript

isPivotTotalColumn: boolean;

Property Value

boolean

isPrimaryKey

Is this the Primary Key Column

TypeScript

isPrimaryKey: boolean;

Property Value

boolean

isSparkline

Is it a Sparkline Column

TypeScript

isSparkline: boolean;

Property Value

boolean

isTreeColumn

Whether Column is the Tree Column (in Tree View)

TypeScript

isTreeColumn: boolean;

Property Value

boolean

isUIHiddenColumn

Whether Column is always hidden in UI but still available programmatically

TypeScript

isUIHiddenColumn: boolean;

Property Value

boolean

moveable

Can Column be moved at run-time to a new position

TypeScript

moveable: boolean;

Property Value

boolean

pinned

The pinned position of the Column

TypeScript

pinned: 'left' | 'right' | false;

Property Value

'left' | 'right' | false

pivotable

Can Column be used in a Pivot Layout

TypeScript

pivotable: boolean;

Property Value

boolean

queryable

Can the Column be in included in Queries / Expressions

TypeScript

queryable: boolean;

Property Value

boolean

readOnly

Is Column editable; returns FALSE if Column has conditional/dynamic editability, assuming some rows are editable

TypeScript

readOnly: boolean;

Property Value

boolean

resizable

Is Column resizable

TypeScript

resizable: boolean;

Property Value

boolean

sortable

Is Column sortable

TypeScript

sortable: boolean;

Property Value

boolean

userAllowedAggFuncs

allowedAggFuncs from the column colDef or defaultColDef as supplied in Grid Options (before Adaptable rewrites allowedAggFuncs for the standard Value Aggregation menu).

TypeScript

userAllowedAggFuncs?: string[];

Property Value

string[]

visible

Is Column currently visible

TypeScript

visible: boolean;

Property Value

boolean

width

Column width

TypeScript

width?: number;

Property Value

number

IsReadOnly

Inherited from AdaptableObject

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

TypeScript

IsReadOnly?: boolean;

Property Value

boolean

PreviousAdaptableClearStateFunction NextAdaptableColumnBase