FlowToPdfOptions
Interface FlowToPdfOptions
interface FlowToPdfOptions extends FlowOptionsProperties
author
stringcreator
stringdebug
booleanWhen true, overlay every node's bounding box in red for layout debugging.
encryption
PdfEncryptionOptionsfooter
(ctx: PageContext) => NodeSame shape as header, but for the bottom of every page.
header
(ctx: PageContext) => NodeBuilder for a page-level header drawn at the top of every page, inside the page's top margin. Receives the current page number and the final total so the header can include "Page X of Y".
The header's reserved height is measured once with pageNumber: 1, totalPages: 1; if your header changes height per page (e.g. wrapping
across multiple lines on some pages) the layout will use the first
measurement.
keywords
string[]margin
EdgesInputproducer
stringprofile
RenderFlowProfileCallbackOptional low-level pagination profiler. Events are emitted synchronously as renderFlow progresses.
reserveBottom
numberNumber of points to leave free at the bottom of every page on top of the footer (if any). Children that would extend past the bottom bound are pushed to the next page intact (no mid-child page breaks).
save
Omit<SaveOptions, "useObjectStreams"> & { useObjectStreams?: boolean }size
PageSizePage size; defaults to LETTER (612×792) to match pdf-lib.
subject
stringtitle
stringwarnings
booleanWhen true (default), emit a console.warn if a top-level child's
measured width exceeds the page's content area — a common footgun when
hardcoded layout widths drift from the chosen page size. Set to false
to silence (e.g. in tests that deliberately overflow).