Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxCsvExporterOptions

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

Hierarchy

Hierarchy (view full)

Constructors

Properties

Accessors

Constructors

constructor

Properties

alwaysExportHeaders

alwaysExportHeaders: boolean = true

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

let alwaysExportHeaders = this.exportOptions.alwaysExportHeaders;
this.exportOptions.alwaysExportHeaders = false;

Memberof

IgxExporterOptionsBase

exportSummaries

exportSummaries: boolean = true

Specifies whether the exported data should include column summaries.

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

Memberof

IgxExporterOptionsBase

freezeHeaders

freezeHeaders: boolean = false

Specifies whether the exported data should have frozen headers.

let freezeHeaders = this.exportOptions.freezeHeaders;
this.exportOptions.freezeHeaders = true;

Memberof

IgxExporterOptionsBase

ignoreColumnsOrder

ignoreColumnsOrder: boolean = false

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

let ignoreColumnsOrder = this.exportOptions.ignoreColumnsOrder;
this.exportOptions.ignoreColumnsOrder = true;

Memberof

IgxExporterOptionsBase

ignoreColumnsVisibility

ignoreColumnsVisibility: boolean = false

Specifies whether hidden columns should be exported.

let ignoreColumnsVisibility = this.exportOptions.ignoreColumnsVisibility;
this.exportOptions.ignoreColumnsVisibility = true;

Memberof

IgxExporterOptionsBase

ignoreFiltering

ignoreFiltering: boolean = false

Specifies whether filtered out rows should be exported.

let ignoreFiltering = this.exportOptions.ignoreFiltering;
this.exportOptions.ignoreFiltering = true;

Memberof

IgxExporterOptionsBase

ignoreGrouping

ignoreGrouping: boolean = false

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

let ignoreGrouping = this.exportOptions.ignoreGrouping;
this.exportOptions.ignoreGrouping = true;

Memberof

IgxExporterOptionsBase

ignoreMultiColumnHeaders

ignoreMultiColumnHeaders: boolean = false

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

let ignoreMultiColumnHeaders = this.exportOptions.ignoreMultiColumnHeaders;
this.exportOptions.ignoreMultiColumnHeaders = true;

Memberof

IgxExporterOptionsBase

ignoreSorting

ignoreSorting: boolean = false

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;

Memberof

IgxExporterOptionsBase

Accessors

fileName

fileType

valueDelimiter