Class IgxExcelExporterOptions

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

Hierarchy

Index

Constructors

constructor

Properties

exportAsTable

exportAsTable: boolean = true

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

let exportAsTable = this.exportOptions.exportAsTable;
this.exportOptions.exportAsTable = false;
@memberof

IgxExcelExporterOptions

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

ignorePinning

ignorePinning: boolean = false

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;
@memberof

IgxExcelExporterOptions

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

columnWidth

  • get columnWidth(): number
  • set columnWidth(value: number): void

fileName

  • get fileName(): string
  • set fileName(value: string): void

rowHeight

  • get rowHeight(): number
  • set rowHeight(value: number): void

worksheetName

  • get worksheetName(): string
  • set worksheetName(value: string): void