Ignite UI for Angular Column Group

Constructors

Section titled "Constructors"

IgcColumnGroupComponent 

new IgcColumnGroupComponent(args: any[]): IgcColumnGroupComponent

Returns IgcColumnGroupComponent

Properties

Section titled "Properties"

tagName

Section titled "tagName"

The tagName read-only property of the Element interface returns the tag name of the element on which it's called.

MDN Reference

 
tagName: string

Accessors

Section titled "Accessors"

additionalTemplateContext

Section titled "additionalTemplateContext"

Inherited from: IgcColumnComponent 

get additionalTemplateContext(): any

Returns any

Sets/gets custom properties provided in additional template context.

 
set additionalTemplateContext(value: any): void

Parameters

  • value: any

Returns void

autosizeHeader

Section titled "autosizeHeader"

Inherited from: IgcColumnComponent 

get autosizeHeader(): boolean

Returns boolean

Sets/gets whether the column header is included in autosize logic. Useful when template for a column header is sized based on parent, for example a default div. Default value is false.

 
set autosizeHeader(value: boolean): void

Parameters

  • value: boolean

Returns void

bodyTemplate

Section titled "bodyTemplate"

Inherited from: IgcColumnComponent

Returns a reference to the bodyTemplate.

 
set bodyTemplate(value: IgcRenderFunction<IgcCellTemplateContext>): void

Parameters

Returns void

cellClasses

Section titled "cellClasses"

Inherited from: IgcColumnComponent 

get cellClasses(): any

Returns any

Sets a conditional class selector of the column cells. Accepts an object literal, containing key-value pairs, where the key is the name of the CSS class, while the value is either a callback function that returns a boolean, or boolean, like so:

 
set cellClasses(value: any): void

Parameters

  • value: any

Returns void

cellStyles

Section titled "cellStyles"

Inherited from: IgcColumnComponent 

get cellStyles(): any

Returns any

Sets conditional style properties on the column cells. Similar to ngStyle it accepts an object literal where the keys are the style properties and the value is the expression to be evaluated. As with cellClasses it accepts a callback function.

 
set cellStyles(value: any): void

Parameters

  • value: any

Returns void

childColumns

Section titled "childColumns"

A list containing all the child columns under this column (if any). Empty without children or if this column is not Group or Layout.

 
get childColumns(): IgcColumnComponent[]

Returns IgcColumnComponent[]

children

Section titled "children"

Returns the child elements.

MDN Reference

 
get children(): HTMLCollection

Returns HTMLCollection 

set children(value: HTMLCollection): void

Parameters

  • value: HTMLCollection

Returns void

colEnd

Section titled "colEnd"

Inherited from: IgcColumnComponent 

get colEnd(): number

Returns number

Column index where the current field should end. The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field

 
set colEnd(value: number): void

Parameters

  • value: number

Returns void

collapsible

Section titled "collapsible" 
get collapsible(): boolean

Returns boolean

Set if the column group is collapsible. Default value is false

 
set collapsible(value: boolean): void

Parameters

  • value: boolean

Returns void

collapsibleIndicatorTemplate

Section titled "collapsibleIndicatorTemplate"

Allows you to define a custom template for expand/collapse indicator

 
set collapsibleIndicatorTemplate(value: IgcRenderFunction<IgcColumnTemplateContext>): void

Parameters

Returns void

colStart

Section titled "colStart"

Inherited from: IgcColumnComponent 

get colStart(): number

Returns number

Column index from which the field is starting.

 
set colStart(value: number): void

Parameters

  • value: number

Returns void

columnGroup

Section titled "columnGroup"

Returns a boolean indicating if the column is a ColumnGroup.

 
get columnGroup(): boolean

Returns boolean

columnLayout

Section titled "columnLayout"

Returns a boolean indicating if the column is a ColumnLayout for multi-row layout.

 
get columnLayout(): boolean

Returns boolean

columnLayoutChild

Section titled "columnLayoutChild"

Inherited from: IgcColumnComponent

Returns a boolean indicating if the column is a child of a ColumnLayout for multi-row layout.

 
get columnLayoutChild(): boolean

Returns boolean

dataType

Section titled "dataType"

Inherited from: IgcColumnComponent 

get dataType(): GridColumnDataType

Returns GridColumnDataType

Sets/gets the data type of the column values. Default value is string.

 
set dataType(value: GridColumnDataType): void

Parameters

Returns void

disabledSummaries

Section titled "disabledSummaries"

Inherited from: IgcColumnComponent 

get disabledSummaries(): string[]

Returns string[]

Sets/gets the summary operands to exclude from display. Accepts an array of string keys representing the summary types to disable, such as 'Min', 'Max', 'Count' etc.

 
set disabledSummaries(value: string[]): void

Parameters

  • value: string[]

Returns void

disableHiding

Section titled "disableHiding"

Inherited from: IgcColumnComponent 

get disableHiding(): boolean

Returns boolean

Gets whether the hiding is disabled.

 
set disableHiding(value: boolean): void

Parameters

  • value: boolean

Returns void

disablePinning

Section titled "disablePinning"

Inherited from: IgcColumnComponent 

get disablePinning(): boolean

Returns boolean

Gets whether the pinning is disabled.

 
set disablePinning(value: boolean): void

Parameters

  • value: boolean

Returns void

editable

Section titled "editable"

Inherited from: IgcColumnComponent 

get editable(): boolean

Returns boolean

Gets whether the column is editable. Default value is false.

 
set editable(value: boolean): void

Parameters

  • value: boolean

Returns void

editorOptions

Section titled "editorOptions"

Inherited from: IgcColumnComponent 

get editorOptions(): IgcColumnEditorOptions

Returns IgcColumnEditorOptions

Pass optional properties for the default column editors.

 
set editorOptions(value: IgcColumnEditorOptions): void

Parameters

Returns void

errorTemplate

Section titled "errorTemplate"

Inherited from: IgcColumnComponent

Returns a reference to the validation error template.

 
set errorTemplate(value: IgcRenderFunction<IgcCellTemplateContext>): void

Parameters

Returns void

expanded

Section titled "expanded" 
get expanded(): boolean

Returns boolean

Set whether the group is expanded or collapsed initially. Applied only if the collapsible property is set to true Default value is true

 
set expanded(value: boolean): void

Parameters

  • value: boolean

Returns void

field

Section titled "field"

Inherited from: IgcColumnComponent 

get field(): string

Returns string

Sets/gets the field value.

 
set field(value: string): void

Parameters

  • value: string

Returns void

filterable

Section titled "filterable"

Inherited from: IgcColumnComponent 

get filterable(): boolean

Returns boolean

Sets/gets whether the column is filterable. Default value is true.

 
set filterable(value: boolean): void

Parameters

  • value: boolean

Returns void

filterCellTemplate

Section titled "filterCellTemplate"

Inherited from: IgcColumnComponent

Returns a reference to the filterCellTemplate.

 
set filterCellTemplate(value: IgcRenderFunction<IgcColumnTemplateContext>): void

Parameters

Returns void

filteringExpressionsTree

Section titled "filteringExpressionsTree"

Inherited from: IgcColumnComponent

Returns the filteringExpressionsTree of the column.

 
get filteringExpressionsTree(): IgcFilteringExpressionsTree

Returns IgcFilteringExpressionsTree

filteringIgnoreCase

Section titled "filteringIgnoreCase"

Inherited from: IgcColumnComponent 

get filteringIgnoreCase(): boolean

Returns boolean

Sets/gets whether the column filtering should be case sensitive. Default value is true.

 
set filteringIgnoreCase(value: boolean): void

Parameters

  • value: boolean

Returns void

filters

Section titled "filters"

Gets the column group filters.

 
get filters(): any

Returns any

formatter

Section titled "formatter"

Inherited from: IgcColumnComponent 

get formatter(): any

Returns any

Applies display format to cell values in the column. Does not modify the underlying data.

 
set formatter(value: any): void

Parameters

  • value: any

Returns void

groupable

Section titled "groupable"

Inherited from: IgcColumnComponent 

get groupable(): boolean

Returns boolean

Sets/gets whether the column is groupable. Default value is false.

 
set groupable(value: boolean): void

Parameters

  • value: boolean

Returns void

hasSummary

Section titled "hasSummary"

Inherited from: IgcColumnComponent 

get hasSummary(): boolean

Returns boolean

Gets a value indicating whether the summary for the column is enabled.

 
set hasSummary(value: boolean): void

Parameters

  • value: boolean

Returns void

Section titled "header"

Inherited from: IgcColumnComponent 

get header(): string

Returns string

Sets/gets the header value.

 
set header(value: string): void

Parameters

  • value: string

Returns void

headerClasses

Section titled "headerClasses"

Inherited from: IgcColumnComponent 

get headerClasses(): string

Returns string

Sets/gets the class selector of the column header.

 
set headerClasses(value: string): void

Parameters

  • value: string

Returns void

headerGroupClasses

Section titled "headerGroupClasses"

Inherited from: IgcColumnComponent 

get headerGroupClasses(): string

Returns string

Sets/gets the class selector of the column group header.

 
set headerGroupClasses(value: string): void

Parameters

  • value: string

Returns void

headerGroupStyles

Section titled "headerGroupStyles"

Inherited from: IgcColumnComponent 

get headerGroupStyles(): any

Returns any

Sets conditional style properties on the column header group wrapper. Similar to ngStyle it accepts an object literal where the keys are the style properties and the value is the expression to be evaluated.

 
set headerGroupStyles(value: any): void

Parameters

  • value: any

Returns void

headerStyles

Section titled "headerStyles"

Inherited from: IgcColumnComponent 

get headerStyles(): any

Returns any

Sets conditional style properties on the column header. Similar to ngStyle it accepts an object literal where the keys are the style properties and the value is the expression to be evaluated.

 
set headerStyles(value: any): void

Parameters

  • value: any

Returns void

headerTemplate

Section titled "headerTemplate"

Inherited from: IgcColumnComponent

Returns a reference to the header template.

 
set headerTemplate(value: IgcRenderFunction<IgcColumnTemplateContext>): void

Parameters

Returns void

hidden

Section titled "hidden"

Gets whether the column group is hidden.

 
get hidden(): boolean

Returns boolean

index

Section titled "index"

Inherited from: IgcColumnComponent

Gets the column index.

 
get index(): number

Returns number

inlineEditorTemplate

Section titled "inlineEditorTemplate"

Inherited from: IgcColumnComponent

Returns a reference to the inline editor template.

 
set inlineEditorTemplate(value: IgcRenderFunction<IgcCellTemplateContext>): void

Parameters

Returns void

level

Section titled "level"

Inherited from: IgcColumnComponent

Returns the level of the column in a column group. Returns 0 if the column doesn't have a parent.

 
get level(): number

Returns number

maxWidth

Section titled "maxWidth"

Inherited from: IgcColumnComponent 

get maxWidth(): string

Returns string

Sets/gets the maximum width of the column.

 
set maxWidth(value: string): void

Parameters

  • value: string

Returns void

merge

Section titled "merge"

Inherited from: IgcColumnComponent 

get merge(): boolean

Returns boolean

Sets/gets whether to merge cells in this column.

 
set merge(value: boolean): void

Parameters

  • value: boolean

Returns void

minWidth

Section titled "minWidth"

Inherited from: IgcColumnComponent 

get minWidth(): string

Returns string

Sets/gets the minimum width of the column. Default value is 88;

 
set minWidth(value: string): void

Parameters

  • value: string

Returns void

parent

Section titled "parent"

Inherited from: IgcColumnComponent 

get parent(): IgcColumnComponent

Returns IgcColumnComponent

Sets/gets the parent column.

 
set parent(value: IgcColumnComponent): void

Parameters

Returns void

pinned

Section titled "pinned"

Inherited from: IgcColumnComponent 

get pinned(): boolean

Returns boolean

Gets whether the column is pinned.

 
set pinned(value: boolean): void

Parameters

  • value: boolean

Returns void

pinningPosition

Section titled "pinningPosition"

Inherited from: IgcColumnComponent 

get pinningPosition(): ColumnPinningPosition

Returns ColumnPinningPosition

Gets the pinning position of the column.

 
set pinningPosition(value: ColumnPinningPosition): void

Parameters

Returns void

pipeArgs

Section titled "pipeArgs"

Inherited from: IgcColumnComponent 

get pipeArgs(): IgcColumnPipeArgs

Returns IgcColumnPipeArgs 

set pipeArgs(value: IgcColumnPipeArgs): void

Parameters

Returns void

resizable

Section titled "resizable"

Inherited from: IgcColumnComponent 

get resizable(): boolean

Returns boolean

Sets/gets whether the column is resizable. Default value is false.

 
set resizable(value: boolean): void

Parameters

  • value: boolean

Returns void

rowEnd

Section titled "rowEnd"

Inherited from: IgcColumnComponent 

get rowEnd(): number

Returns number

Row index where the current field should end. The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field

 
set rowEnd(value: number): void

Parameters

  • value: number

Returns void

rowStart

Section titled "rowStart"

Inherited from: IgcColumnComponent 

get rowStart(): number

Returns number

Row index from which the field is starting.

 
set rowStart(value: number): void

Parameters

  • value: number

Returns void

searchable

Section titled "searchable"

Inherited from: IgcColumnComponent 

get searchable(): boolean

Returns boolean

Sets/gets whether the column is searchable. Default value is true.

 
set searchable(value: boolean): void

Parameters

  • value: boolean

Returns void

selectable

Section titled "selectable"

Returns if the column group is selectable

 
get selectable(): boolean

Returns boolean

selected

Section titled "selected"

Returns if the column group is selected.

 
get selected(): boolean

Returns boolean

sortable

Section titled "sortable"

Inherited from: IgcColumnComponent 

get sortable(): boolean

Returns boolean

Sets/gets whether the column is sortable. Default value is false.

 
set sortable(value: boolean): void

Parameters

  • value: boolean

Returns void

sortingIgnoreCase

Section titled "sortingIgnoreCase"

Inherited from: IgcColumnComponent 

get sortingIgnoreCase(): boolean

Returns boolean

Sets/gets whether the column sorting should be case sensitive. Default value is true.

 
set sortingIgnoreCase(value: boolean): void

Parameters

  • value: boolean

Returns void

sortStrategy

Section titled "sortStrategy"

Inherited from: IgcColumnComponent 

get sortStrategy(): IgcSortingStrategy

Returns IgcSortingStrategy

Gets the column sortStrategy.

 
set sortStrategy(value: IgcSortingStrategy): void

Parameters

Returns void

summaries

Section titled "summaries"

Gets the column group summaries.

 
get summaries(): any

Returns any

summaryFormatter

Section titled "summaryFormatter"

Inherited from: IgcColumnComponent 

get summaryFormatter(): any

Returns any

The summaryFormatter is used to format the display of the column summaries. In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers.

 
set summaryFormatter(value: any): void

Parameters

  • value: any

Returns void

summaryTemplate

Section titled "summaryTemplate"

Inherited from: IgcColumnComponent

Returns a reference to the summaryTemplate.

 
set summaryTemplate(value: IgcRenderFunction<IgcSummaryTemplateContext>): void

Parameters

Returns void

title

Section titled "title"

Inherited from: IgcColumnComponent

The HTMLElement.title property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.

MDN Reference

 
get title(): string

Returns string

Sets/gets the title value.

 
set title(value: string): void

Parameters

  • value: string

Returns void

topLevelParent

Section titled "topLevelParent"

Inherited from: IgcColumnComponent

Returns a reference to the top level parent column.

 
get topLevelParent(): IgcColumnComponent

Returns IgcColumnComponent

visibleIndex

Section titled "visibleIndex"

Inherited from: IgcColumnComponent

Gets the column visible index. If the column is not visible, returns -1.

 
get visibleIndex(): number

Returns number

visibleWhenCollapsed

Section titled "visibleWhenCollapsed"

Inherited from: IgcColumnComponent 

get visibleWhenCollapsed(): boolean

Returns boolean

Indicates whether the column will be visible when its parent is collapsed.

 
set visibleWhenCollapsed(value: boolean): void

Parameters

  • value: boolean

Returns void

width

Section titled "width"

Gets the width of the column group.

 
get width(): string

Returns string

Methods

Section titled "Methods"

addEventListener

Section titled "addEventListener"

Inherited from: IgcColumnComponent 

addEventListener(type: K, listener: object, options: boolean | AddEventListenerOptions): void

Parameters

  • type: K
  • listener: object
  • options: boolean | AddEventListenerOptions

Returns void

autosize

Section titled "autosize"

Inherited from: IgcColumnComponent

Autosize the column to the longest currently visible cell value, including the header cell.

 
autosize(byHeaderOnly: boolean): void

Parameters

  • byHeaderOnly: boolean

    Set if column should be autosized based only on the header content.

Returns void

move

Section titled "move"

Inherited from: IgcColumnComponent

Moves a column to the specified visible index. If passed index is invalid, or if column would receive a different visible index after moving, moving is not performed. If passed index would move the column to a different column group. moving is not performed.

 
move(index: number): void

Parameters

  • index: number

Returns void

pin

Section titled "pin"

Inherited from: IgcColumnComponent

Pins the column in the specified position at the provided index in that pinned area. Defaults to index 0 if not provided, or to the initial index in the pinned area. Returns true if the column is successfully pinned. Returns false if the column cannot be pinned. Column cannot be pinned if:

  • Is already pinned
  • index argument is out of range
 
pin(index: number, pinningPosition: ColumnPinningPosition): boolean

Parameters

Returns boolean

removeEventListener

Section titled "removeEventListener"

Inherited from: IgcColumnComponent 

removeEventListener(type: K, listener: object, options: boolean | EventListenerOptions): void

Parameters

  • type: K
  • listener: object
  • options: boolean | EventListenerOptions

Returns void

unpin

Section titled "unpin"

Inherited from: IgcColumnComponent

Unpins the column and place it at the provided index in the unpinned area. Defaults to index 0 if not provided, or to the initial index in the unpinned area. Returns true if the column is successfully unpinned. Returns false if the column cannot be unpinned. Column cannot be unpinned if:

  • Is already unpinned
  • index argument is out of range
 
unpin(index: number): boolean

Parameters

  • index: number

Returns boolean

register

Section titled "register" 
register(): void

Returns void