IExportingPDFOptions

Type interface

Sources

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

Inheritance

IExportingPDFOptions extends IExportingImageOptions.

IExportingPDFOptions is not extended by any other symbol.

Properties

#addURL

Type undefined | false | trueDefault true

Adds the URL of the page the chart was exported from.

#align

Type "left" | "center" | "middle"Default "left"

Horizontal alignment of the chart image on the page: "left", "center" or "right".

#extraFonts

Type Array

More fonts to register, for use by individual elements of the document, e.g. from a pdfdocready listener. Used only together with font.

More info: Exporting PDF: fonts

#font

Type IFont

Font of the PDF's text. The default font has only Latin and Cyrillic characters, so text in other scripts needs a font that has them.

More info: Exporting PDF: fonts

#fontSize

Type undefined | numberDefault 14

Font size of the title, the page URL and the data table.

#imageFormat

Type "png" | "jpg"Default "png"

Format of the chart image in the PDF.

#includeData

Type undefined | false | true

Adds a table of the dataSource data below the chart image.

#pageMargins

Type number | number[]Default 30

Page margins in points (1/72 inch): one number for all four edges, [horizontal, vertical], or [left, top, right, bottom].

#pageOrientation

Type "landscape" | "portrait"Default "portrait"

Page orientation.

#pageSize

Type pageSizesDefault "A4"

Page size.

7 inherited items

#disabled

Type undefined | false | trueInherited from IExportingFormatOptions

Leaves this format out of the ExportingMenu.

#maintainPixelRatio

Type undefined | false | trueDefault falseInherited from IExportingImageOptions

Exports the image at the chart's size in CSS pixels. When false, it is exported at the screen's resolution: larger on high-density screens.

More info: Exporting to image formats: pixel ratio

#maxHeight

Type undefined | numberInherited from IExportingImageOptions

Maximal height of exported image, in pixels.

More info: Exporting to image formats: sizing exported image

#maxWidth

Type undefined | numberInherited from IExportingImageOptions

Maximal width of exported image, in pixels.

More info: Exporting to image formats: sizing exported image

#minHeight

Type undefined | numberInherited from IExportingImageOptions

Minimal height of exported image, in pixels.

More info: Exporting to image formats: sizing exported image

#minWidth

Type undefined | numberInherited from IExportingImageOptions

Minimal width of exported image, in pixels.

More info: Exporting to image formats: sizing exported image

#quality

Type undefined | numberInherited from IExportingImageOptions

Quality of the image, 0 to 1: 1 by default, 0.8 for JPG. Only JPEG images use it.