Provides a pre-configured exporter component for the grid.
Igx Module
IgxGridToolbarModule

Remarks

[object Object]

Constructors

Section titled "Constructors"

IgxGridToolbarExporterComponent

new IgxGridToolbarExporterComponent(): IgxGridToolbarExporterComponent

Returns IgxGridToolbarExporterComponent

Properties

Section titled "Properties"

closed

Section titled "closed"

Inherited from: BaseToolbarDirective

Emits an event after the toggle container is closed.

 
closed: EventEmitter<ToggleViewEventArgs>

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar.base.ts:79

closing

Section titled "closing"

Inherited from: BaseToolbarDirective

Emits an event before the toggle container is closed.

 
closing: EventEmitter<ToggleViewEventArgs>

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar.base.ts:73

columnListHeight

Section titled "columnListHeight"

Inherited from: BaseToolbarDirective

Sets the height of the column list in the dropdown.

 
columnListHeight: string

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar.base.ts:29

columnToggle

Section titled "columnToggle"

Inherited from: BaseToolbarDirective

Emits when after a column's checked state is changed

 
columnToggle: EventEmitter<IColumnToggledEventArgs>

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar.base.ts:85

exportCSV

Section titled "exportCSV"

Show entry for CSV export.

 
exportCSV: boolean = true

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar-exporter.component.ts:59

exportEnded

Section titled "exportEnded"

Emitted on successful ending of an export operation.

 
exportEnded: EventEmitter<void>

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar-exporter.component.ts:90

exportExcel

Section titled "exportExcel"

Show entry for Excel export.

 
exportExcel: boolean = true

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar-exporter.component.ts:65

exportPDF

Section titled "exportPDF"

Show entry for PDF export.

 
exportPDF: boolean = true

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar-exporter.component.ts:71

exportStarted

Section titled "exportStarted"

Emitted when starting an export operation. Re-emitted additionally by the grid itself.

 
exportStarted: EventEmitter<IgxExporterEvent>

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar-exporter.component.ts:84

filename

Section titled "filename"

The name for the exported file.

 
filename: string = 'ExportedData'

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar-exporter.component.ts:77

opened

Section titled "opened"

Inherited from: BaseToolbarDirective

Emits an event after the toggle container is opened.

 
opened: EventEmitter<ToggleViewEventArgs>

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar.base.ts:67

opening

Section titled "opening"

Inherited from: BaseToolbarDirective

Emits an event before the toggle container is opened.

 
opening: EventEmitter<ToggleViewCancelableEventArgs>

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar.base.ts:61

prompt

Section titled "prompt"

Inherited from: BaseToolbarDirective

The placeholder text for the search input.

 
prompt: string

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar.base.ts:41

title

Section titled "title"

Inherited from: BaseToolbarDirective

Title text for the column action component

 
title: string

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar.base.ts:35

overlaySettings

Section titled "overlaySettings"

Inherited from: BaseToolbarDirective 

overlaySettings: OverlaySettings

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar.base.ts:47, projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar.base.ts:54

Methods

Section titled "Methods"

export

Section titled "export"

Export the grid's data

export(type: "pdf" | "excel" | "csv"): void

Defined in projects/igniteui-angular/grids/core/src/toolbar/grid-toolbar-exporter.component.ts:107

Parameters

  • type: "pdf" | "excel" | "csv"

    File type to export

Returns void