Class IgxExcelExporterOptions

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

Hierarchy

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

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

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.

let ignoreSorting = this.exportOptions.ignoreSorting;
this.exportOptions.ignoreSorting = true;
memberof

IgxExporterOptionsBase

Accessors

columnWidth

  • get columnWidth(): number
  • set columnWidth(value: number): void
  • Gets the width of the columns in the exported excel file.

    let width = this.exportOptions.columnWidth;
    memberof

    IgxExcelExporterOptions

    Returns number

  • Sets the width of the columns in the exported excel file. If left unspecified or 0, the width of the largest string in the column will be used.

    this.exportOptions.columnWidth = 55;
    memberof

    IgxExcelExporterOptions

    Parameters

    • value: number

    Returns void

fileName

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

rowHeight

  • get rowHeight(): number
  • set rowHeight(value: number): void
  • Gets the height of the rows in the exported excel file.

    let height = this.exportOptions.rowHeight;
    memberof

    IgxExcelExporterOptions

    Returns number

  • Sets the height of the rows in the exported excel file. If left unspecified or 0, the default height of the excel rows will be used.

    this.exportOptions.rowHeight = 25;
    memberof

    IgxExcelExporterOptions

    Parameters

    • value: number

    Returns void