Class IgxGridToolbarComponent

This class encapsulates the Toolbar's logic and is internally used by the IgxGridComponent, IgxTreeGridComponent and IgxHierarchicalGridComponent.

Hierarchy

Implements

  • DoCheck
  • OnInit

Constructors

constructor

Properties

cdr

cdr: ChangeDetectorRef

columnHidingButton

columnHidingButton: IgxButtonDirective

Provides a reference to the Column Hiding button.

const hidingButton = this.grid.toolbar.columnHidingButton;

columnHidingDropdown

columnHidingDropdown: IgxDropDownComponent

Provides a reference to the IgxDropDownComponent of the Column Hiding UI.

const dropdownHiding = this.grid.toolbar.columnHidingDropdown;

columnHidingUI

columnHidingUI: IgxColumnHidingComponent

Provides a reference to the IgxColumnHidingComponent.

const hidingUI = this.grid.toolbar.columnHidingUI;

columnPinningButton

columnPinningButton: IgxButtonDirective

Provides a reference to the Column Pinning button.

const pinningButton = this.grid.toolbar.columnPinningButton;

columnPinningDropdown

columnPinningDropdown: IgxDropDownComponent

Provides a reference to the IgxDropDownComponent of the Column Pinning UI.

const dropdownPinning = this.grid.toolbar.columnPinningDropdown;

columnPinningUI

columnPinningUI: IgxColumnPinningComponent

Provides a reference to the IgxColumnPinningComponent.

const pinningUI = this.grid.toolbar.columnPinningDropdown;

csvExporter

excelExporter

exportButton

exportButton: IgxButtonDirective

Provides a reference to the Export button.

const exportBtn = this.grid.toolbar.exportButton;

exportDropdown

exportDropdown: IgxDropDownComponent

Provides a reference to the IgxDropDownComponent of the Export button.

const exportDropdown = this.grid.toolbar.exportDropdown;

gridAPI

gridAPI: GridBaseAPIService<IgxGridBaseComponent & IGridDataBindable>

onDensityChanged

onDensityChanged: EventEmitter<IDensityChangedEventArgs> = new EventEmitter<IDensityChangedEventArgs>()

Accessors

context

  • get context(): any
  • Returns the context object which represents the template context binding into the toolbar custom container by providing references to the parent IgxGird and the toolbar itself.

    const context =  this.igxGrid.toolbar.context;

    Returns any

defaultDropDownsMaxHeight

  • get defaultDropDownsMaxHeight(): string
  • Gets the height for the IgxGridToolbarComponent's drop down panels.

    const dropdownHeight = this.grid.toolbar.defaultDropDownsMaxHeight;

    Returns string

displayDensity

filterColumnsPrompt

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

grid

hostClass

  • get hostClass(): string

pinnedColumnsCount

  • get pinnedColumnsCount(): number

shouldShowExportButton

  • get shouldShowExportButton(): boolean
  • Returns whether the IgxGridComponent renders an export button.

    const exportButton = this.igxGrid1.toolbar.shouldShowExportButton;

    Returns boolean

shouldShowExportCsvButton

  • get shouldShowExportCsvButton(): boolean
  • Returns whether the IgxGridComponent renders an CSV export button.

    const exportCSVButton = this.igxGrid1.toolbar.shouldShowExportCsvButton;

    Returns boolean

shouldShowExportExcelButton

  • get shouldShowExportExcelButton(): boolean
  • Returns whether the IgxGridComponent renders an Excel export button.

    const exportExcelButton = this.igxGrid1.toolbar.shouldShowExportExcelButton;

    Returns boolean

Methods

exportClicked

  • exportClicked(): void

exportToCsvClicked

  • exportToCsvClicked(): void

exportToExcelClicked

  • exportToExcelClicked(): void

getExportCsvText

  • getExportCsvText(): string
  • Returns the text of the CSV export button of the IgxGridToolbarComponent.

    const toolbarCSVText = this.igxGrid1.toolbar.getExportCsvText();

    Returns string

getExportExcelText

  • getExportExcelText(): string
  • Returns the text of the Excel export button of the IgxGridToolbarComponent.

    const toolbarExcelText = this.igxGrid1.toolbar.getExportExcelText();

    Returns string

getExportText

  • getExportText(): string
  • Returns the text of the export button of the IgxGridToolbarComponent.

    const toolbarExportText = this.igxGrid1.toolbar.getTitle();

    Returns string

getTitle

  • getTitle(): string

ngDoCheck

  • ngDoCheck(): void

toggleColumnHidingUI

  • toggleColumnHidingUI(): void

toggleColumnPinningUI

  • toggleColumnPinningUI(): void