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

Constructors

Section titled "Constructors"

IgcExcelExporterOptions 

new IgcExcelExporterOptions(fileName: string): IgcExcelExporterOptions

Returns IgcExcelExporterOptions

Accessors

Section titled "Accessors"

alwaysExportHeaders

Section titled "alwaysExportHeaders"

Inherited from: IgcExporterOptionsBase 

get alwaysExportHeaders(): boolean

Returns boolean

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

 
set alwaysExportHeaders(value: boolean): void

Parameters

  • value: boolean

Returns void

columnWidth

Section titled "columnWidth" 
get columnWidth(): number

Returns number

Gets the width of the columns in the exported excel file.

 
set columnWidth(value: number): void

Parameters

  • value: number

Returns void

exportAsTable

Section titled "exportAsTable" 
get exportAsTable(): boolean

Returns boolean

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

 
set exportAsTable(value: boolean): void

Parameters

  • value: boolean

Returns void

exportSummaries

Section titled "exportSummaries"

Inherited from: IgcExporterOptionsBase 

get exportSummaries(): boolean

Returns boolean

Specifies whether the exported data should include column summaries.

 
set exportSummaries(value: boolean): void

Parameters

  • value: boolean

Returns void

fileName

Section titled "fileName"

Inherited from: IgcExporterOptionsBase 

get fileName(): string

Returns string

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

 
set fileName(value: string): void

Parameters

  • value: string

Returns void

freezeHeaders

Section titled "freezeHeaders"

Inherited from: IgcExporterOptionsBase 

get freezeHeaders(): boolean

Returns boolean

Specifies whether the exported data should have frozen headers.

 
set freezeHeaders(value: boolean): void

Parameters

  • value: boolean

Returns void

ignoreColumnsOrder

Section titled "ignoreColumnsOrder"

Inherited from: IgcExporterOptionsBase 

get ignoreColumnsOrder(): boolean

Returns boolean

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

 
set ignoreColumnsOrder(value: boolean): void

Parameters

  • value: boolean

Returns void

ignoreColumnsVisibility

Section titled "ignoreColumnsVisibility"

Inherited from: IgcExporterOptionsBase 

get ignoreColumnsVisibility(): boolean

Returns boolean

Specifies whether hidden columns should be exported.

 
set ignoreColumnsVisibility(value: boolean): void

Parameters

  • value: boolean

Returns void

ignoreFiltering

Section titled "ignoreFiltering"

Inherited from: IgcExporterOptionsBase 

get ignoreFiltering(): boolean

Returns boolean

Specifies whether filtered out rows should be exported.

 
set ignoreFiltering(value: boolean): void

Parameters

  • value: boolean

Returns void

ignoreGrouping

Section titled "ignoreGrouping"

Inherited from: IgcExporterOptionsBase 

get ignoreGrouping(): boolean

Returns boolean

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

 
set ignoreGrouping(value: boolean): void

Parameters

  • value: boolean

Returns void

ignoreMultiColumnHeaders

Section titled "ignoreMultiColumnHeaders"

Inherited from: IgcExporterOptionsBase 

get ignoreMultiColumnHeaders(): boolean

Returns boolean

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

 
set ignoreMultiColumnHeaders(value: boolean): void

Parameters

  • value: boolean

Returns void

ignorePinning

Section titled "ignorePinning" 
get ignorePinning(): boolean

Returns boolean

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

 
set ignorePinning(value: boolean): void

Parameters

  • value: boolean

Returns void

ignoreSorting

Section titled "ignoreSorting"

Inherited from: IgcExporterOptionsBase 

get ignoreSorting(): boolean

Returns boolean

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.

 
set ignoreSorting(value: boolean): void

Parameters

  • value: boolean

Returns void

rowHeight

Section titled "rowHeight" 
get rowHeight(): number

Returns number

Gets the height of the rows in the exported excel file.

 
set rowHeight(value: number): void

Parameters

  • value: number

Returns void

worksheetName

Section titled "worksheetName" 
get worksheetName(): string

Returns string

Gets the name of the worksheet in the exported excel file.

 
set worksheetName(value: string): void

Parameters

  • value: string

Returns void