Constructors

  • Parameters

    • fileName: string
    • _fileExtension: string

    Returns IgcExporterOptionsBase

Accessors

  • get alwaysExportHeaders(): boolean
  • Returns boolean

  • set alwaysExportHeaders(value): void
  • Specifies whether the headers should be exported if there is no data.

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

    Memberof

    IgxExporterOptionsBase

    Parameters

    • value: boolean

    Returns void

  • get exportSummaries(): boolean
  • Returns boolean

  • set exportSummaries(value): void
  • Specifies whether the exported data should include column summaries.

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

    Memberof

    IgxExporterOptionsBase

    Parameters

    • value: boolean

    Returns void

  • get fileName(): string
  • Returns string

  • set fileName(value): void
  • Gets the file name which will be used for the exporting operation.

    let fileName = this.exportOptions.fileName;
    

    Memberof

    IgxExporterOptionsBase

    Parameters

    • value: string

    Returns void

  • get freezeHeaders(): boolean
  • Returns boolean

  • set freezeHeaders(value): void
  • Specifies whether the exported data should have frozen headers.

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

    Memberof

    IgxExporterOptionsBase

    Parameters

    • value: boolean

    Returns void

  • get ignoreColumnsOrder(): boolean
  • Returns boolean

  • set ignoreColumnsOrder(value): void
  • Specifies if the exporter should ignore the current column order in the IgxGrid.

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

    Memberof

    IgxExporterOptionsBase

    Parameters

    • value: boolean

    Returns void

  • get ignoreColumnsVisibility(): boolean
  • Returns boolean

  • set ignoreColumnsVisibility(value): void
  • Specifies whether hidden columns should be exported.

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

    Memberof

    IgxExporterOptionsBase

    Parameters

    • value: boolean

    Returns void

  • get ignoreFiltering(): boolean
  • Returns boolean

  • set ignoreFiltering(value): void
  • Specifies whether filtered out rows should be exported.

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

    Memberof

    IgxExporterOptionsBase

    Parameters

    • value: boolean

    Returns void

  • get ignoreGrouping(): boolean
  • Returns boolean

  • set ignoreGrouping(value): void
  • Specifies whether the exported data should be grouped as in the provided IgxGrid.

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

    Memberof

    IgxExporterOptionsBase

    Parameters

    • value: boolean

    Returns void

  • get ignoreMultiColumnHeaders(): boolean
  • Returns boolean

  • set ignoreMultiColumnHeaders(value): void
  • 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

    Parameters

    • value: boolean

    Returns void

  • get ignoreSorting(): boolean
  • Returns boolean

  • set ignoreSorting(value): void
  • 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

    Parameters

    • value: boolean

    Returns void