IExportPDFOptions

Type interface

Represents options for PDF export.

Sources

IExportPDFOptions is an interface: it describes a shape of data and is not imported on its own.

Inheritance

IExportPDFOptions extends IExportImageOptions.

IExportPDFOptions is not extended by any other symbol.

Properties

#addColumnNames

Type booleanDefault trueSince 4.7.0

Add column names in first row?

Export will try to use user-friendly column names where possible, either from Export's dataFields or deduced from chart's series' names that are bound to specific data fields.

#addData

Type booleanDefault falseSince 4.7.0

Should data table be included together with the image?

Use "pdfdata" options to configure table output.

#addURL

Type booleanDefault true

Whether to add a URL of the web page the chart has been exported from.

#align

Type AlignDefault leftSince 4.9.14

Alignment of the chart image in PDF.

Supported options: "left" (default), "center", "right".

#disabled

Type booleanSince 4.9.11

Set this option to disabled for a format to not show up in ExportMenu.

#emptyAs

Type anyDefault "" (empty string)Since 4.7.0

Replace missing values with this.

#extraFonts

Type Array <IFont>Since 4.9.19

Additional optional fonts which can be used on individual elements.

More info: Using PDF export fonts

#font

Type IFontSince 4.9.19

Font which should be used for the export.

Default font used for PDF includes only Latin-based and Cyrilic characters. If you are exporting text in other languages, you might need to use some other export font.

More info: Using PDF export fonts

#fontSize

Type number

Font size to use for all texts.

#imageFormat

Type imageFormats

An image format to use for embedded images in PDF.

See imageFormats in Export_module.

#maxHeight

Type numberSince 4.10.13

Maximum height in pixels of the exported image. If source chart is bigger thank this, it will be scaled down.

NOTE: this setting might be overidden by minHeight.

#maxWidth

Type numberSince 4.10.13

Maximum width in pixels of the exported image. If source chart is bigger thank this, it will be scaled down.

NOTE: this setting might be overidden by minWidth.

#minHeight

Type numberSince 4.10.13

Minimum height in pixels of the exported image. If source chart is smaller thank this, it will be scaled up.

#minWidth

Type numberSince 4.10.13

Minimum width in pixels of the exported image. If source chart is smaller thank this, it will be scaled up.

#pageMargins

Type number | number[]

Page margins.

Can be one of the following:

A single number, in which case it will act as margin setting for all four edges of the page.

An array of two numbers [ horizontal, vertical ].

An array of four numbers [ left, top, right, bottom ].

#pageOrientation

Type "landscape" | "portrait"

Page orientation.

#pageSize

Type pageSizes

Page size of the exported PDF.

#pivot

Type booleanDefault falseSince 4.7.0

If set to true will export data as pivoted (column names in first column;

values in rows).

#scale

Type numberDefault 1Since 4.10.13

Rescale image.

Number less than 1 will shrink the image.

Number bigger than 1 will scale up the image.

#useLocale

Type booleanDefault trueSince 4.7.0

Will try to format numbers and date/time according to user's locale settings.

#useTimestamps

Type booleanDefault falseSince 4.7.0

Use timestamps instead of formatted date/time values.

2 inherited items

#keepTainted

Type booleanDefault falseInherited from IExportImageOptions

Normally, Export removes "tainted" images (images that are loaded from other host than the chart itself) before export.

Set this to true to disable it.

Please note that removal of tainted images might trigger cross-origin security restrictions in browser and prevent the whole export operation, so use with caution.

#quality

Type numberInherited from IExportImageOptions

Quality of the exported image. (0-1)