Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxPdfExporterOptions

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

Hierarchy

Hierarchy (View Summary)

Constructors

Properties

Accessors

Constructors

Properties

alwaysExportHeaders: boolean = true

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

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

IgxExporterOptionsBase

exportSummaries: boolean = true

Specifies whether the exported data should include column summaries.

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

IgxExporterOptionsBase

fontSize: number = 10

Specifies the font size for the table content. (10 by default)

let fontSize = this.exportOptions.fontSize;
this.exportOptions.fontSize = 12;

IgxPdfExporterOptions

freezeHeaders: boolean = false

Specifies whether the exported data should have frozen headers.

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

IgxExporterOptionsBase

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;

IgxExporterOptionsBase

ignoreColumnsVisibility: boolean = false

Specifies whether hidden columns should be exported.

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

IgxExporterOptionsBase

ignoreFiltering: boolean = false

Specifies whether filtered out rows should be exported.

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

IgxExporterOptionsBase

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;

IgxExporterOptionsBase

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;

IgxExporterOptionsBase

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;

IgxExporterOptionsBase

pageOrientation: "portrait" | "landscape" = 'landscape'

Specifies the page orientation. (portrait or landscape, landscape by default)

let pageOrientation = this.exportOptions.pageOrientation;
this.exportOptions.pageOrientation = 'portrait';

IgxPdfExporterOptions

pageSize: string = 'a4'

Specifies the page size. (a4, a3, letter, legal, etc., a4 by default)

let pageSize = this.exportOptions.pageSize;
this.exportOptions.pageSize = 'letter';

IgxPdfExporterOptions

showTableBorders: boolean = true

Specifies whether to show table borders. (True by default)

let showTableBorders = this.exportOptions.showTableBorders;
this.exportOptions.showTableBorders = false;

IgxPdfExporterOptions

Accessors