ColumnType
Represents a column in the GridType. It is essentially the blueprint to a column object.
Contains definitions of properties and methods, relevant to a column
Properties
Section titled "Properties"additionalTemplateContext
Section titled "additionalTemplateContext"additionalTemplateContext: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:337
applySelectableClass
Section titled "applySelectableClass"applySelectableClass: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:344
calcWidth
Section titled "calcWidth"Custom CSS styling, applied to every column calcWidth, minWidthPx, maxWidthPx, minWidth, maxWidth, minWidthPercent, maxWidthPercent, resolvedWidth
calcWidth: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:209
children
Section titled "children"A list containing all the child columns under this column (if any).
children: QueryList<ColumnType> Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:171
colEnd
Section titled "colEnd"colEnd: number Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:314
Optional collapsible
Section titled "collapsible"Optional Indicated whether the column can be collapsed. If the value is true, the column can be collapsed It is used in tree grid and for navigation
collapsible?: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:251
Optional collapsibleIndicatorTemplate
Section titled "collapsibleIndicatorTemplate"The template reference for the collapsible indicator of the column. It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
collapsibleIndicatorTemplate?: TemplateRef<any> Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:195
colStart
Section titled "colStart"colStart: number Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:313
columnGroup
Section titled "columnGroup"Specifies whether the column belongs to a group of columns.
columnGroup: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:259
columnLayout
Section titled "columnLayout"columnLayout: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:308
columnLayoutChild
Section titled "columnLayoutChild"columnLayoutChild: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:319
dataType
Section titled "dataType"Represents the type of data for the column: string, number, boolean, currency, date, time, etc.
dataType: GridColumnDataType Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:232
Optional defaultDateTimeFormat
Section titled "defaultDateTimeFormat"Inherited from: FieldType
Default date/time format for Date/Time fields.
defaultDateTimeFormat?: string Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:148
Optional defaultTimeFormat
Section titled "defaultTimeFormat"Inherited from: FieldType
Default time format for Date/Time fields.
defaultTimeFormat?: string Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:143
Optional disabledSummaries
Section titled "disabledSummaries"disabledSummaries?: string[] Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:293
disableHiding
Section titled "disableHiding"Indicates whether a column can be hidden. If the value is true, the column cannot be hidden
disableHiding: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:271
disablePinning
Section titled "disablePinning"Indicates whether a column can be pinned. If the value is true, the column cannot be pinned
disablePinning: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:269
editable
Section titled "editable"Indicated whether the column can be edited. If the value is true, the column can be edited
editable: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:253
editorOptions
Section titled "editorOptions"Sets properties on the default column editors
editorOptions: IColumnEditorOptions Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:236
expanded
Section titled "expanded"Indicates if the column is currently expanded or collapsed. If the value is true, the column is expanded
expanded: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:302
field
Section titled "field"Inherited from: FieldType
The internal field name, used in expressions and queries.
field: string Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:112
filterable
Section titled "filterable"Indicates whether a column can be filtered. If the value is true, the column can be filtered
filterable: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:265
filterCellTemplate
Section titled "filterCellTemplate"Represents a custom template for filtering It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
filterCellTemplate: TemplateRef<any> Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:355
filteringExpressionsTree
Section titled "filteringExpressionsTree"The filtering expressions for the column. The type contains properties and methods for filtering: filteringOperands, operator (logic), fieldName, etc.
filteringExpressionsTree: FilteringExpressionsTree Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:290
filteringIgnoreCase
Section titled "filteringIgnoreCase"filteringIgnoreCase: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:285
Optional filters
Section titled "filters"Inherited from: FieldType
Optional filtering operands that apply to this field.
filters?: IgxFilteringOperand Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:133
Represents the instance of the parent GridType that contains this column.
grid: GridTypeBase Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:166
groupable
Section titled "groupable"Indicates whether a column can be put in a group. If the value is true, the column can be put in a group
groupable: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:261
groupingComparer
Section titled "groupingComparer"Represents a method with custom grouping comparator to determine the members of the group.
groupingComparer: object Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:349
hasNestedPath
Section titled "hasNestedPath"hasNestedPath: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:336
hasSummary
Section titled "hasSummary"hasSummary: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:291
Optional header
Section titled "header"Optional Represents the header text of the column
header?: string Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:222
headerClasses
Section titled "headerClasses"Represents custom CSS classes applied to the header element. When added, they take different styling
headerClasses: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:197
headerGroupClasses
Section titled "headerGroupClasses"Represents custom CSS classes applied to the header group. When added, they take different styling
headerGroupClasses: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:201
headerGroupStyles
Section titled "headerGroupStyles"Represents custom CSS styles applied to the header group. When added, they take different styling
headerGroupStyles: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:203
headerStyles
Section titled "headerStyles"Represents custom CSS styles applied to the header element. When added, they take different styling
headerStyles: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:199
headerTemplate
Section titled "headerTemplate"The template reference for the custom header of the column It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
headerTemplate: TemplateRef<any> Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:190
hidden
Section titled "hidden"Indicates whether a column is currently hidden (not visible). If the value is true, the column is not visible
hidden: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:267
index
Section titled "index"The index of the column within the grid. Includes the hidden columns when counting
index: number Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:227
inlineEditorTemplate
Section titled "inlineEditorTemplate"The template reference for the custom inline editor of the column It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
inlineEditorTemplate: TemplateRef<any> Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:241
isFirstPinned
Section titled "isFirstPinned"Indicates whether the current column is the first for the grid to be pinned. If the value is false, there are columns, that have been pinned before the current
isFirstPinned: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:343
isLastPinned
Section titled "isLastPinned"Indicates whether the current column is the last to be pinned. If the value is false, there are columns, that have been pinned after the current
isLastPinned: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:340
Optional label
Section titled "label"Inherited from: FieldType
Display label for the field.
label?: string Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:107
level
Section titled "level"Represents the hierarchical level of the column in the column layout
level: number Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:310
maxWidth
Section titled "maxWidth"maxWidth: string Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:213
maxWidthPercent
Section titled "maxWidthPercent"maxWidthPercent: number Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:215
maxWidthPx
Section titled "maxWidthPx"maxWidthPx: number Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:211
merge
Section titled "merge"merge: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:303
mergingComparer
Section titled "mergingComparer"mergingComparer: object Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:184
minWidth
Section titled "minWidth"minWidth: string Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:212
minWidthPercent
Section titled "minWidthPercent"minWidthPercent: number Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:214
minWidthPx
Section titled "minWidthPx"minWidthPx: number Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:210
parent
Section titled "parent"Optional The immediate parent (right above) column of this column (if any). If there is no parent, that means the current column is the root parent
parent: ColumnType Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:334
pinned
Section titled "pinned"Indicates if the column is currently pinned. If the value is true, the column is pinned
pinned: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:300
pipeArgs
Section titled "pipeArgs"Optional arguments for any pipe applied to the field.
pipeArgs: IColumnPipeArgs Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:335
resizable
Section titled "resizable"Specifies whether the column can be resized. If the value is true, the column can be resized
resizable: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:255
resolvedWidth
Section titled "resolvedWidth"resolvedWidth: string Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:216
rowEnd
Section titled "rowEnd"rowEnd: number Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:312
rowStart
Section titled "rowStart"rowStart: number Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:311
searchable
Section titled "searchable"Specifies whether the data of the column can be searched. If the value is true, the column data can be searched
searchable: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:257
selectable
Section titled "selectable"Indicates if the column can be selected. If the value is true, the column can be selected
selectable: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:307
selected
Section titled "selected"Indicates if the column is currently selected. If the value is true, the column is selected
selected: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:305
sortable
Section titled "sortable"Indicates whether a column can be sorted. If the value is true, the column can be sorted.
sortable: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:263
sortingIgnoreCase
Section titled "sortingIgnoreCase"Indicates whether the search should match results, no matter the case of the letters (upper and lower)
If the value is false, the result will depend on the case (example: E will not match e)
If the value is true, the result will not depend on the case (example: E will match e)
sortingIgnoreCase: boolean Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:282
sortStrategy
Section titled "sortStrategy"The sorting strategy used for sorting this column. The interface contains a method sort that sorts the provided data based on the given sorting expressions
sortStrategy: ISortingStrategy Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:276
summaries
Section titled "summaries"summaries: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:292
summaryTemplate
Section titled "summaryTemplate"The template reference for a summary of the column It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views
summaryTemplate: TemplateRef<any> Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:298
title
Section titled "title"The title of the column, used for accessibility purposes
title: string Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:346
Optional topLevelParent
Section titled "topLevelParent"Optional The root parent of this column (if any). If there is no root parent, that means the current column is the root parent
topLevelParent?: ColumnType Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:326
validators
Section titled "validators"validators: any[] Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:183
visibleIndex
Section titled "visibleIndex"The index of the column within the grid. Does not include the hidden columns when counting
visibleIndex: number Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:246
width
Section titled "width"width: string Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:320
Accessors
Section titled "Accessors"childColumns
Section titled "childColumns"childColumns: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:176
Methods
Section titled "Methods"Optional formatter
Section titled "formatter"Inherited from: FieldType
formatter?: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:157
getAutoSize
Section titled "getAutoSize"getAutoSize: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:363
getCellWidth
Section titled "getCellWidth"getCellWidth: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:366
getGridTemplate
Section titled "getGridTemplate"getGridTemplate: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:367
getResizableColUnderEnd
Section titled "getResizableColUnderEnd"getResizableColUnderEnd: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:364
move: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:361
pin: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:372
Optional populateVisibleIndexes
Section titled "populateVisibleIndexes"populateVisibleIndexes?: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:370
toggleVisibility
Section titled "toggleVisibility"toggleVisibility: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:369
unpin
Section titled "unpin"unpin: any Defined in projects/igniteui-angular/core/src/data-operations/grid-types.ts:374