Interface 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

Hierarchy

Hierarchy

Implemented by

Properties

additionalTemplateContext: any
allChildren: ColumnType[]

An array, containing all the child columns, including nested children.

applySelectableClass: boolean
calcWidth: any

Custom CSS styling, appplied to every column calcWidth, minWidthPx, maxWidthPx, minWidth, maxWidth, minWidthPercent, maxWidthPercent, resolvedWidth

children: QueryList<ColumnType>

A list, containing all the child columns under this column (if any).

colEnd: number
colStart: number
collapsible?: boolean

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

collapsibleIndicatorTemplate?: TemplateRef<any>

The template reference for the collapsible indicator of the column. It is of type TemplateRef, which represents an embedded template, used to instanciate embedded views

columnGroup: boolean

Specifies whether the column belongs to a group of columns.

columnLayout: boolean
columnLayoutChild: boolean
dataType: GridColumnDataType

Represents the type of data for the column: string, number, buulean, currency, date, time, etc.

defaultDateTimeFormat: string
defaultTimeFormat: string
disableHiding: boolean

Indicades whether a column can be hidden. If the value is true, the column cannot be hidden

disablePinning: boolean

Indicades whether a column can be pinned. If the value is true, the column cannot be pinned

editable: boolean

Indicated whether the column can be edited. If the value is true, the column can be edited

expanded: boolean

Indicates if the column is currently expanded or collapsed. If the value is true, the column is expanded

field: string
filterCell: any
filterCellTemplate: TemplateRef<any>

Represents a custom template for filtering It is of type TemplateRef, which represents an embedded template, used to instanciate embedded views

filterable: boolean

Indicades whether a column can be filtered. If the value is true, the column can be filtered

filteringExpressionsTree: FilteringExpressionsTree

The filtering expressions for the column. The type contains properties and methods for filtering: filteringOperands, operator (logic), fieldName, etc.

filteringIgnoreCase: boolean
grid: GridType

Represents the inctance of the parent GridType that contains this column.

gridColumnSpan: number
gridRowSpan: number
groupable: boolean

Indicades whether a column can be put in a group. If the value is true, the column can be put in a group

groupingComparer: ((a, b) => number)

Type declaration

    • (a, b): number
    • Represents a method with custom grouping comparator to determine the members of the group.

      Parameters

      • a: any
      • b: any

      Returns number

hasNestedPath: boolean
hasSummary: boolean
header?: string

Optional Represents the header text of the column

headerCell: any

The header cell component associated with this column. Could be of any type

headerClasses: any

Represents custom CSS classes applied to the header element. When added, they take different styling

headerGroup: any

The header group component associated with this column. Could be of any type

headerGroupClasses: any

Represents custom CSS classes applied to the header group. When added, they take different styling

headerGroupStyles: any

Represents custom CSS styles applied to the header group. When added, they take different styling

headerStyles: any

Represents custom CSS styles applied to the header element. When added, they take different styling

headerTemplate: TemplateRef<any>

The template reference for the custom header of the column It is of type TemplateRef, which represents an embedded template, used to instanciate embedded views

hidden: boolean

Indicades whether a column is currently hidden (not visible). If the value is true, the column is not visible

index: number

The index of the column within the grid. Includes the hidden columns when counting

inlineEditorTemplate: TemplateRef<any>

The template reference for the custom inline editor of the column It is of type TemplateRef, which represents an embedded template, used to instanciate embedded views

isFirstPinned: boolean

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

isLastPinned: boolean

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

label?: string
level: number

Represents the hierarchical level of the column in the column layout

maxWidth: string
maxWidthPercent: number
maxWidthPx: number
minWidth: string
minWidthPercent: number
minWidthPx: number
movable: boolean

Deprecated

in version 13.1.0. Use IgxGridComponent.moving instead.

parent?: ColumnType

Optional The immediate parent (right above) column of this column (if any). If there is no parent, that means the current solunm is the root parent

pinned: boolean

Indicates if the column is currently pinned. If the value is true, the column is pinned

pipeArgs: IFieldPipeArgs
resizable: boolean

Specifies whether the column can be resized. If the value is true, the column can be resized

resolvedWidth: string
rowEnd: number
rowStart: number
searchable: boolean

Specifies whether the data of the column can be searched. If the value is true, the column data can be searched

selectable: boolean

Indicates if the column can be selected. If the value is true, the column can be selected

selected: boolean

Indicates if the column is currently selected. If the value is true, the column is selected

sortStrategy: ISortingStrategy

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

sortable: boolean

Indicades whether a column can be sorted. If the value is true, the column can be sorted.

sortingIgnoreCase: boolean

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)

summaries: any
summaryTemplate: TemplateRef<any>

The template reference for a summary of the column It is of type TemplateRef, which represents an embedded template, used to instanciate embedded views

title: string

The title of the column, used for accessibility purposes

topLevelParent?: ColumnType

Optional The root parent of this column (if any). If there is no root parent, that means the current solunm is the root parent

validators: any[]
visibleIndex: number

The index of the column within the grid. Does not include the hidden columns when counting

width: string

Methods