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

Constructors

Section titled "Constructors"

IgxCsvExporterOptions 

new IgxCsvExporterOptions(fileName: string, fileType: CsvFileTypes): IgxCsvExporterOptions

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

Returns IgxCsvExporterOptions

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

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 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"

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 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"

Inherited from: IgxExporterOptionsBase

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"

Inherited from: IgxExporterOptionsBase

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"

Inherited from: IgxExporterOptionsBase

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

fileType

Section titled "fileType"

Gets the CSV export format.

let filetype = this.exportOptions.fileType;
get fileType(): any

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

Returns any

Sets the CSV export format.

this.exportOptions.fileType = CsvFileTypes.TAB;
set fileType(value: any): void

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

Parameters

  • value: any

Returns void

valueDelimiter

Section titled "valueDelimiter"

Gets the value delimiter which will be used for the exporting operation.

let delimiter = this.exportOptions.valueDelimiter;
get valueDelimiter(): any

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

Returns any

Sets a value delimiter which will overwrite the default delimiter of the selected export format.

this.exportOptions.valueDelimiter = '|';
set valueDelimiter(value: any): void

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

Parameters

  • value: any

Returns void