Objects of this class are used to configure the Excel exporting process.

Constructors

Section titled "Constructors"

IgxExcelExporterOptions

new IgxExcelExporterOptions(fileName: string): IgxExcelExporterOptions

Defined in projects/igniteui-angular/grids/core/src/services/excel/excel-exporter-options.ts:35

Returns IgxExcelExporterOptions

Properties

Section titled "Properties"

alwaysExportHeaders

Section titled "alwaysExportHeaders"

Inherited from: IgxExporterOptionsBase

Specifies whether the headers should be exported if there is no data.

let alwaysExportHeaders = this.exportOptions.alwaysExportHeaders;
this.exportOptions.alwaysExportHeaders = false;
alwaysExportHeaders: boolean = true

Defined in projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts:101

exportAsTable

Section titled "exportAsTable"

Specifies whether the exported data should be formatted as Excel table. (True by default)

let exportAsTable = this.exportOptions.exportAsTable;
this.exportOptions.exportAsTable = false;
exportAsTable: boolean = true

Defined in projects/igniteui-angular/grids/core/src/services/excel/excel-exporter-options.ts:29

exportSummaries

Section titled "exportSummaries"

Inherited from: IgxExporterOptionsBase

Specifies whether the exported data should include column summaries.

let exportSummaries = this.exportOptions.exportSummaries;
this.exportOptions.exportSummaries = true;
exportSummaries: boolean = true

Defined in projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts:79

freezeHeaders

Section titled "freezeHeaders"

Inherited from: IgxExporterOptionsBase

Specifies whether the exported data should have frozen headers.

let freezeHeaders = this.exportOptions.freezeHeaders;
this.exportOptions.freezeHeaders = true;
freezeHeaders: boolean = false

Defined in projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts:90

ignoreColumnsOrder

Section titled "ignoreColumnsOrder"

Inherited from: IgxExporterOptionsBase

Specifies if the exporter should ignore the current column order in the IgxGrid.

let ignoreColumnsOrder = this.exportOptions.ignoreColumnsOrder;
this.exportOptions.ignoreColumnsOrder = true;
ignoreColumnsOrder: boolean = false

Defined in projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts:33

ignoreColumnsVisibility

Section titled "ignoreColumnsVisibility"

Inherited from: IgxExporterOptionsBase

Specifies whether hidden columns should be exported.

let ignoreColumnsVisibility = this.exportOptions.ignoreColumnsVisibility;
this.exportOptions.ignoreColumnsVisibility = true;
ignoreColumnsVisibility: boolean = false

Defined in projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts:11

ignoreFiltering

Section titled "ignoreFiltering"

Inherited from: IgxExporterOptionsBase

Specifies whether filtered out rows should be exported.

let ignoreFiltering = this.exportOptions.ignoreFiltering;
this.exportOptions.ignoreFiltering = true;
ignoreFiltering: boolean = false

Defined in projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts:22

ignoreGrouping

Section titled "ignoreGrouping"

Inherited from: IgxExporterOptionsBase

Specifies whether the exported data should be grouped as in the provided IgxGrid.

let ignoreGrouping = this.exportOptions.ignoreGrouping;
this.exportOptions.ignoreGrouping = true;
ignoreGrouping: boolean = false

Defined in projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts:57

ignoreMultiColumnHeaders

Section titled "ignoreMultiColumnHeaders"

Inherited from: IgxExporterOptionsBase

Specifies whether the exported data should include multi column headers as in the provided IgxGrid.

let ignoreMultiColumnHeaders = this.exportOptions.ignoreMultiColumnHeaders;
this.exportOptions.ignoreMultiColumnHeaders = true;
ignoreMultiColumnHeaders: boolean = false

Defined in projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts:68

ignorePinning

Section titled "ignorePinning"

Specifies if column pinning should be ignored. If ignoreColumnsOrder is set to true, this option will always be considered as set to true.

let ignorePinning = this.exportOptions.ignorePinning;
this.exportOptions.ignorePinning = true;
ignorePinning: boolean = false

Defined in projects/igniteui-angular/grids/core/src/services/excel/excel-exporter-options.ts:18

ignoreSorting

Section titled "ignoreSorting"

Inherited from: IgxExporterOptionsBase

Specifies whether the exported data should be sorted as in the provided IgxGrid. When you export grouped data, setting ignoreSorting to true will cause the grouping to fail because it relies on the sorting of the records.

let ignoreSorting = this.exportOptions.ignoreSorting;
this.exportOptions.ignoreSorting = true;
ignoreSorting: boolean = false

Defined in projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts:46

columnWidth

Section titled "columnWidth" 
columnWidth: number

Defined in projects/igniteui-angular/grids/core/src/services/excel/excel-exporter-options.ts:47, projects/igniteui-angular/grids/core/src/services/excel/excel-exporter-options.ts:60

fileName

Section titled "fileName"

Inherited from: IgxExporterOptionsBase 

fileName: string

Defined in projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts:121, projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts:133

rowHeight

Section titled "rowHeight" 
rowHeight: number

Defined in projects/igniteui-angular/grids/core/src/services/excel/excel-exporter-options.ts:76, projects/igniteui-angular/grids/core/src/services/excel/excel-exporter-options.ts:89

worksheetName

Section titled "worksheetName" 
worksheetName: string

Defined in projects/igniteui-angular/grids/core/src/services/excel/excel-exporter-options.ts:105, projects/igniteui-angular/grids/core/src/services/excel/excel-exporter-options.ts:121