Class IgxColumnHidingComponent

Hierarchy

  • ColumnChooserBaseDirective
    • IgxColumnHidingComponent

Implements

  • OnDestroy
  • OnDestroy

Constructors

constructor

Properties

cdr

cdr: ChangeDetectorRef

columnsAreaMaxHeight

columnsAreaMaxHeight: string = "100%"

Access to the columnHidingUI:

@ViewChild('column-hiding-component')
 public columnHidingUI: IgxColumnHidingComponent;

Sets/gets the max height of the column area.

let columnsAreaMaxHeight =  this.columnHidingUI.columnsAreaMaxHeight;
<igx-column-hiding [columnsAreaMaxHeight]="200px"></igx-column-hiding>

cssClass

cssClass: string = "igx-column-hiding"

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

let cssCLass =  this.columnHidingUI.cssClass;
this.columnHidingUI.cssClass = 'column-chooser';

disableFilter

disableFilter: boolean = false

Hides/ shows the filtering columns input from the UI.

hideAllText

hideAllText: string = "Hide All"

Sets/gets the text of the button that hides all columns if they are shown.

let hideAllButtonText =  this.columnHiding.hideAllText;
<igx-column-hiding [hideAllText] = "'Hide Columns'"></igx-column-hiding>
@memberof

IgxColumnHidingComponent

onColumnVisibilityChanged

onColumnVisibilityChanged: EventEmitter<IColumnVisibilityChangedEventArgs> = new EventEmitter<IColumnVisibilityChangedEventArgs>()

An event that is emitted after the columns visibility is changed. Provides references to the column and the newValue properties as event arguments.

 <igx-column-hiding (onColumnVisibilityChanged) = "onColumnVisibilityChanged($event)"></igx-column-hiding>
@memberof

IgxColumnHidingComponent

showAllText

showAllText: string = "Show All"

Sets/gets the text of the button that shows all columns if they are hidden.

let showAllButtonText =  this.columnHiding.showAllText;
<igx-column-hiding [showAllText] = "'Show Columns'"></igx-column-hiding>
@memberof

IgxColumnHidingComponent

Accessors

columnDisplayOrder

  • get columnDisplayOrder(): "Alphabetical" | "DisplayOrder"
  • set columnDisplayOrder(value: ColumnDisplayOrder): void

columnItems

  • get columnItems(): any[]

columns

  • get columns(): any[]
  • set columns(value: any[]): void

disableHideAll

  • get disableHideAll(): boolean
  • Returns a boolean indicating whether the HIDE ALL button is disabled.

    <igx-column-hiding #columnHidingUI
        [columns]="grid.columns" [title]="'Column Hiding'">
    </igx-column-hiding>
    @ViewChild("'columnHidingUI'")
    public columnHiding: IgxColumnHidingComponent;
    let isHideAlldisabled =  this.columnHiding.disableHideAll;
    @memberof

    IgxColumnHidingComponent

    Returns boolean

disableShowAll

  • get disableShowAll(): boolean

filterColumnsPrompt

  • get filterColumnsPrompt(): string
  • set filterColumnsPrompt(value: string): void

filterCriteria

  • get filterCriteria(): string
  • set filterCriteria(value: string): void

hiddenColumnsCount

  • get hiddenColumnsCount(): number

title

  • get title(): string
  • set title(value: string): void

Methods

hideAllColumns

  • hideAllColumns(): void

showAllColumns

  • showAllColumns(): void