IExportPDFOptions

Type interface

Represents options for PDF export.

Inheritance

IExportPDFOptions extends IExportImageOptions.

IExportPDFOptions is not extended by any other symbol.

Properties

addURL
#

Type boolean

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

@default true

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.

keepTainted
#

Type boolean

Inherited 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.

@default false

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.

See pageSizes in Export_module.

quality
#

Type number

Inherited from IExportImageOptions

Quality of the exported image. (0-1)

scale
#

Type number

Inherited from IExportImageOptions

Rescale image.

Number less than 1 will shrink the image.

Number bigger than 1 will scale up the image.

@default 1

There are 3 inherited items currently hidden from this list.