Documentation

IExportingPDFOptions

Type interface

Inheritance

IExportingPDFOptions extends IExportingImageOptions.

IExportingPDFOptions is not extended by any other symbol.

Properties

addURL #	Type `undefined` \| `false` \| `true` Default `true` Whether to add a URL of the web page the chart has been exported from.
align #	Type `"left"` \| `"center"` \| `"middle"` Default `left` Alignment of the chart image in PDF. Supported options: `"left"` (default), `"center"`, `"right"`.
disabled #	Type `undefined` \| `false` \| `true` Inherited from `IExportingFormatOptions` If set to `true`, this format will not appear in `ExportMenu`.
extraFonts #	Type `Array` Additional optional fonts which can be used on individual elements. Click here for more info
font #	Type `IFont` 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. Click here for more info
fontSize #	Type `undefined` \| `number` Font size to use for all texts.
imageFormat #	Type `"png"` \| `"jpg"` An image format to use for embedded images in PDF. See `imageFormats` in `Export_module`.
includeData #	Type `undefined` \| `false` \| `true` Include data into PDF
maintainPixelRatio #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `IExportingImageOptions` Export images with hardware resolution (`false`), or the way they appear on screen (`true`). Click here for more info
maxHeight #	Type `undefined` \| `number` Inherited from `IExportingImageOptions` Maximal height of exported image, in pixels. Click here for more info
maxWidth #	Type `undefined` \| `number` Inherited from `IExportingImageOptions` Maximal width of exported image, in pixels. Click here for more info
minHeight #	Type `undefined` \| `number` Inherited from `IExportingImageOptions` Minimal height of exported image, in pixels. Click here for more info
minWidth #	Type `undefined` \| `number` Inherited from `IExportingImageOptions` Minimal width of exported image, in pixels. Click here for more info
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.
quality #	Type `undefined` \| `number` Inherited from `IExportingImageOptions` Quality of the exported image: 0 to 1.
There are 7 inherited items currently hidden from this list.