node-zugferd
node-zugferd
@node-zugferd/validator-xsd
@node-zugferd/validator-mustang
@node-zugferd/traffiqx
@node-zugferd/templates
@node-zugferd/pdf-template
T
Align
F
aspectRatio
T
AssetSource
T
BackgroundImage
T
Border
T
BorderSides
I
BoxStyle
T
BoxTransform
T
BreakInside
F
brutalistTheme
F
button
I
ButtonOptions
T
CellVerticalAlign
F
checkbox
I
CheckboxOptions
F
cleanTheme
V
Colors
I
ColumnSpec
T
ColumnWidth
T
CrossAxis
F
definePdfTemplate
F
defineStyles
I
DocumentMetadata
F
dropdown
I
DropdownOptions
T
Edges
T
EdgesInput
F
editorialTheme
F
embedFont
F
flattenForm
F
flex
F
flowContinuation
I
FlowOptions
F
flowToPdf
I
FlowToPdfOptions
F
formatCurrency
I
FormFieldAppearance
T
FormFieldNode
T
FormFieldOptions
T
FormValue
T
Fragmentation
F
getFormValues
F
group
F
hex
F
hline
F
hstack
F
image
F
imageFit
F
inlineNode
I
InlineNodeRun
T
InlineVerticalAlign
T
Justify
F
keepTogether
F
link
F
linkRun
F
loadFont
I
LoadFontOptions
F
loadImage
T
MainAxis
I
MainAxisLayout
F
measure
F
measureContent
I
MeasureProfileEvent
T
Node
F
nodeAdapter
F
optionList
I
OptionListOptions
T
Overflow
F
pageContent
I
PageContext
F
pageInner
I
PageOptions
I
PageSize
V
PageSizes
F
paragraph
I
ParagraphFloat
I
ParagraphFloatLayout
T
ParagraphItem
I
ParagraphLayout
I
ParagraphProps
I
ParagraphRun
C
PDFDocument
C
PdfEncryptionError
T
PdfEncryptionErrorCode
I
PdfEncryptionOptions
C
PDFFont
C
PDFImage
C
PDFPage
I
PdfPermissions
T
Position
F
radioOption
I
RadioOptionOptions
T
RelativeLength
F
render
F
renderFlow
T
RenderFlowProfileCallback
I
RenderFlowProfileEvent
I
RenderOptions
F
renderToPdf
I
RenderToPdfOptions
F
resolveMainAxis
T
RGB
F
rgb255
F
run
F
savePdf
I
SavePdfOptions
F
setFormValues
I
Size
F
spacer
T
StandardFontFamily
F
standardFonts
E
StandardFonts
I
StandardFontSet
F
streamFlow
I
StreamFlowOptions
I
StreamPageContext
F
stripeTheme
F
svgPath
F
table
I
TableCell
T
TableCellInput
I
TableDivider
I
TableOptions
V
text
F
textField
I
TextFieldOptions
I
TextOptions
I
TextProps
I
TextRunStyle
I
Theme
I
ThemeColors
I
ThemedTextStyle
I
ThemeFonts
I
ThemeRadii
I
ThemeSpacing
I
ThemeType
T
TransformOrigin
F
vline
F
vstack
@node-zugferd/parser
@node-zugferd/magic-bytes
@node-zugferd/instrumentation
@node-zugferd/docx-template
@node-zugferd/default-template
@node-zugferd/data-types
@node-zugferd/core

FlowToPdfOptions

Interface FlowToPdfOptions

interface FlowToPdfOptions extends FlowOptions

Properties

author

string

creator

string

debug

boolean

When true, overlay every node's bounding box in red for layout debugging.

encryption

PdfEncryptionOptions

footer

(ctx: PageContext) => Node

Same shape as header, but for the bottom of every page.

header

(ctx: PageContext) => Node

Builder 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

EdgesInput

producer

string

profile

RenderFlowProfileCallback

Optional low-level pagination profiler. Events are emitted synchronously as renderFlow progresses.

reserveBottom

number

Number 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

PageSize

Page size; defaults to LETTER (612×792) to match pdf-lib.

subject

string

title

string

warnings

boolean

When 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).


llms.txt
I
FlowOptions

I
FormFieldAppearance

Edit on GitHubPrivacyImprint