Skip to main content

Interface: SlidePdfExportOptions

Defined in: src/export/SlideDeckExporter.ts:111

Options for exportSlidesToPDF.

Properties​

background?​

optional background: [number, number, number]

Defined in: src/export/SlideDeckExporter.ts:121

Page background fill as [r, g, b] (0-255). Omit for no fill (white page).


captureSlide?​

optional captureSlide: SlideCapturer

Defined in: src/export/SlideDeckExporter.ts:127

DI: per-slide frame capturer. Default seeks and reads canvas.toDataURL.


imageFormat?​

optional imageFormat: string

Defined in: src/export/SlideDeckExporter.ts:123

Image format passed to addImage. Default 'PNG'.


onProgress()?​

optional onProgress: (progress) => void

Defined in: src/export/SlideDeckExporter.ts:129

Progress callback in [0, 1].

Parameters​

progress​

number

Returns​

void


orientation?​

optional orientation: PdfOrientation

Defined in: src/export/SlideDeckExporter.ts:115

Page orientation. Default 'landscape' (slides are usually wide).


pageSize?​

optional pageSize: PdfPageFormat

Defined in: src/export/SlideDeckExporter.ts:117

Page size: a jsPDF format name or [width, height] in unit. Default 'a4'.


pdfFactory?​

optional pdfFactory: PdfFactory

Defined in: src/export/SlideDeckExporter.ts:125

DI: PDF document factory. Default lazy-imports jspdf.


still?​

optional still: "first" | "last"

Defined in: src/export/SlideDeckExporter.ts:113

Which still of each slide to capture: 'first' or 'last' frame. Default 'last'.


unit?​

optional unit: PdfUnit

Defined in: src/export/SlideDeckExporter.ts:119

Measurement unit for the page size. Default 'pt'.