Skip to main content

Interface: PdfOptions

Options of exportPdf: paper, orientation, tiling and what goes on each page.

Properties​

compress?​

compress?: boolean;

Deflate page streams. Default true (false makes the bytes readable, for tests and debugging).


detailLevel?​

detailLevel?: DetailLevel;

edgeStyle?​

edgeStyle?: EdgeStyle;

marks?​

marks?: boolean;

Tiled: cut/registration marks in the overlap and page labels "B2 (row B, column 2)". Default true.


mode​

mode: "tiled" | "pages";

'tiled': each diagram over as many pages as needed at scale; 'pages': one page per source, fit to page.


orientation?​

orientation?: "landscape" | "portrait" | "auto";

Default 'auto': fewest pages (tiled) or largest drawing (pages); ties follow the diagram's aspect.


overlapMm?​

overlapMm?: number;

Tiled: overlap between neighbouring pages, mm. Default 10.


overview?​

overview?: boolean;

Tiled: an overview page first (whole diagram fit to page with the tile grid). Default true when > 1 tile.


palette?​

palette?: PaletteOverrides | null;

Print is always light; only the palette's fonts are honoured (mapped to Helvetica / Courier / Times).


paper?​

paper?: PaperSize;

Default from navigator.language: 'letter' for en-US/en-CA/es-MX, else 'a4'.


scale?​

scale?: number;

Tiled: print scale, diagram px → pt. Default 0.75 (1 px = 1/96 in, i.e. 100 %).


skipEmpty?​

skipEmpty?: boolean;

Tiled: leave out pages no table, note or collapsed group reaches (only ref-line fragments). Labels keep their grid position; the overview crosses the skipped cells out. Default true.


title?​

title?: string;

Document title (PDF metadata and running header).