constructor

• new IgxColumnActionsComponent(
      differs: IterableDiffers,
  ): IgxColumnActionsComponent

• Parameters

  • differs: IterableDiffers

  Returns IgxColumnActionsComponent

columnItems

let columnItems =  this.columnActions.columnItems;
Copy

columnsAreaMaxHeight

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

columnToggled

 <igx-column-actions (columnToggled)="columnToggled($event)"></igx-column-actions>
Copy

cssClass

let cssCLass =  this.columnHidingUI.cssClass;
Copy

this.columnHidingUI.cssClass = 'column-chooser';
Copy

grid

let grid = this.columnActions.grid;
Copy

hideFilter

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

indentation

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

title

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

checkAllText

• get checkAllText(): string

• Gets the text of the button that checks all columns.

  Remarks

  If unset it is obtained from the IgxColumnActionsBased derived directive applied.

  Example

  let uncheckAllText = this.columnActions.uncheckAllText;
  Copy

  Returns string

• set checkAllText(value: string): void

• Sets the text of the button that checks all columns.

  Remarks

  If unset it is obtained from the IgxColumnActionsBased derived directive applied.

  Example

  <igx-column-actions [checkAllText]="'Hide All'"></igx-column-actions>
  Copy

  Parameters

  • value: string

  Returns void

columnDisplayOrder

• get columnDisplayOrder(): ColumnDisplayOrder

• Gets the display order of the columns.

  Example

  let columnDisplayOrder = this.columnActions.columnDisplayOrder;
  Copy

  Returns ColumnDisplayOrder

• set columnDisplayOrder(value: ColumnDisplayOrder): void

• Sets the display order of the columns.

  Example

  this.columnActions.columnDisplayOrder = ColumnDisplayOrder.Alphabetical;
  Copy

  Parameters

  • value: ColumnDisplayOrder

  Returns void

filterColumnsPrompt

• get filterColumnsPrompt(): string

• Gets the prompt that is displayed in the filter input.

  Example

  let filterColumnsPrompt = this.columnActions.filterColumnsPrompt;
  Copy

  Returns string

• set filterColumnsPrompt(value: string): void

• Sets the prompt that is displayed in the filter input.

  Example

  <igx-column-actions [filterColumnsPrompt]="'Type here to search'"></igx-column-actions>
  Copy

  Parameters

  • value: string

  Returns void

filterCriteria

• get filterCriteria(): string

• Gets the value which filters the columns list.

  Example

  let filterCriteria =  this.columnActions.filterCriteria;
  Copy

  Returns string

• set filterCriteria(value: string): void

• Sets the value which filters the columns list.

  Example

   <igx-column-actions [filterCriteria]="'ID'"></igx-column-actions>
  Copy

  Parameters

  • value: string

  Returns void

id

• get id(): string

• Gets/Sets the value of the id attribute.

  Remarks

  If not provided it will be automatically generated.

  Example

  <igx-column-actions [id]="'igx-actions-1'"></igx-column-actions>
  Copy

  Returns string

• set id(value: string): void

• Parameters

  • value: string

  Returns void

uncheckAllText

• get uncheckAllText(): string

• Gets the text of the button that unchecks all columns.

  Remarks

  If unset it is obtained from the IgxColumnActionsBased derived directive applied.

  Example

  let uncheckAllText = this.columnActions.uncheckAllText;
  Copy

  Returns string

• set uncheckAllText(value: string): void

• Sets the text of the button that unchecks all columns.

  Example

  <igx-column-actions [uncheckAllText]="'Show All'"></igx-column-actions>
  Copy

  Parameters

  • value: string

  Returns void

checkAllColumns

• checkAllColumns(): void

• Checks all columns and performs the appropriate action.

  Example

  this.columnActions.checkAllColumns();
  Copy

  Returns void

uncheckAllColumns

• uncheckAllColumns(): void

• Unchecks all columns and performs the appropriate action.

  Example

  this.columnActions.uncheckAllColumns();
  Copy

  Returns void