Constructors

Section titled "Constructors"

IgxExporterOptionsBase 

new IgxExporterOptionsBase(fileName: string, _fileExtension: string): IgxExporterOptionsBase

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

Returns IgxExporterOptionsBase

Properties

Section titled "Properties"

alwaysExportHeaders

Section titled "alwaysExportHeaders"

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

exportSummaries

Section titled "exportSummaries"

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"

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"

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

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"

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"

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"

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

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"

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

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

ignoreSorting

Section titled "ignoreSorting"

Specifies whether the exported data should be sorted as in the provided grid. 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

Accessors

Section titled "Accessors"

fileName

Section titled "fileName"

Gets the file name which will be used for the exporting operation.

let fileName = this.exportOptions.fileName;
get fileName(): string

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

Returns string

Sets the file name which will be used for the exporting operation.

this.exportOptions.fileName = 'exportedData01';
set fileName(value: string): void

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

Parameters

  • value: string

Returns void