Providing reference to IgxColumnActionsComponent:

@ViewChild('columnActions', { read: IgxColumnActionsComponent })
 public columnActions: IgxColumnActionsComponent;

Constructors

Section titled "Constructors"

IgxColumnActionsComponent

new IgxColumnActionsComponent(): IgxColumnActionsComponent

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:165

Returns IgxColumnActionsComponent

Properties

Section titled "Properties"

columnItems

Section titled "columnItems"

Gets the checkbox components representing column items currently present in the dropdown

 
columnItems: QueryList<IgxCheckboxComponent>

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:91

Example

let columnItems =  this.columnActions.columnItems;

columnsAreaMaxHeight

Section titled "columnsAreaMaxHeight"

Gets/sets the max height of the columns area.

 
columnsAreaMaxHeight: string = '100%'

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:71

Remarks

The default max height is 100%.

Example

<igx-column-actions [columnsAreaMaxHeight]="200px"></igx-column-actions>

columnToggled

Section titled "columnToggled"

An event that is emitted after a column's checked state is changed. Provides references to the column and the checked properties as event arguments.

<igx-column-actions (columnToggled)="columnToggled($event)"></igx-column-actions>
columnToggled: EventEmitter<IColumnToggledEventArgs>

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:111

cssClass

Section titled "cssClass"

Sets/Gets the css class selector. By default the value of the class attribute is "igx-column-actions".

let cssCLass =  this.columnHidingUI.cssClass;
this.columnHidingUI.cssClass = 'column-chooser';
cssClass: string = 'igx-column-actions'

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:59

grid

Section titled "grid"

Gets/Sets the grid to provide column actions for.

 
grid: GridType

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:37

Example

let grid = this.columnActions.grid;

hideFilter

Section titled "hideFilter"

Shows/hides the columns filtering input from the UI.

 
hideFilter: boolean = false

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:81

Example

<igx-column-actions [hideFilter]="true"></igx-column-actions>

indentation

Section titled "indentation"

Gets/sets the indentation of columns in the column list based on their hierarchy level.

 
indentation: number = 30

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:47

Example

<igx-column-actions [indentation]="15"></igx-column-actions>

title

Section titled "title"

Gets/sets the title of the column actions component.

 
title: string = ''

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:101

Example

<igx-column-actions [title]="'Pin Columns'"></igx-column-actions>

checkAllText

Section titled "checkAllText" 
checkAllText: string

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:281, projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:294

columnDisplayOrder

Section titled "columnDisplayOrder" 
columnDisplayOrder: ColumnDisplayOrder

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:228, projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:239

filterColumnsPrompt

Section titled "filterColumnsPrompt" 
filterColumnsPrompt: string

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:178, projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:189

filterCriteria

Section titled "filterCriteria" 
filterCriteria: string

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:201, projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:212

id

Section titled "id" 
id: string

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:324, projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:327

uncheckAllText

Section titled "uncheckAllText" 
uncheckAllText: string

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:256, projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:267

Methods

Section titled "Methods"

checkAllColumns

Section titled "checkAllColumns"

Checks all columns and performs the appropriate action.

checkAllColumns(): void

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:375

Returns void

Example

this.columnActions.checkAllColumns();

uncheckAllColumns

Section titled "uncheckAllColumns"

Unchecks all columns and performs the appropriate action.

uncheckAllColumns(): void

Defined in projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts:363

Returns void

Example

this.columnActions.uncheckAllColumns();