zeropdf v1.3.0

---

zeropdf / FlowTextOptions

Interface: FlowTextOptions

Defined in: src/types.ts:1151

Options for placing paragraphs or text blocks through the flow layout API.

Extends

• Omit<TextBlockOptions, "x" | "y" | "width">.FlowBlockSpacingOptions

Extended by

• FlowHeadingOptions

Properties

Property	Type	Description	Inherited from	Defined in
align?	TextAlign	Horizontal alignment for laid-out content.	TextBlockOptions.align	src/types.ts:871
blockAlign?	"left" | "center" | "right"	Alignment of the block inside the flow column.	-	src/types.ts:1156
blockWidth?	number	Optional width for the flow text block within the flow column.	-	src/types.ts:1154
bold?	boolean	Selects the bold variant of font. See TextOptions.bold.	TextBlockOptions.bold	src/types.ts:849
characterSpacing?	number	Additional spacing between characters in PDF points.	TextBlockOptions.characterSpacing	src/types.ts:865
color?	ColorInput	Color used for drawing, text, or highlighting.	TextBlockOptions.color	src/types.ts:863
direction?	TextDirection	Text direction used for shaping and layout.	TextBlockOptions.direction	src/types.ts:859
encoding?	"winansi" | "macroman" | "pdfdoc"	Built-in font encoding. When set, the font dictionary emits an /Encoding entry with the specified encoding (e.g. /WinAnsiEncoding). When undefined, the default encoding is used.	TextBlockOptions.encoding	src/types.ts:901
fallbackFonts?	PdfFont[]	Fallback fonts used when the primary font lacks a glyph.	TextBlockOptions.fallbackFonts	src/types.ts:857
font?	PdfFont	Font used to render text.	TextBlockOptions.font	src/types.ts:847
fontSize?	number	Font size in PDF points.	TextBlockOptions.fontSize	src/types.ts:861
height?	number	Box height in PDF points. When set together with verticalAlign, the wrapped lines are positioned within a box of this height starting at y and extending downward. Has no effect unless verticalAlign is given.	TextBlockOptions.height	src/types.ts:877
italic?	boolean	Selects the italic variant of font. See TextOptions.italic.	TextBlockOptions.italic	src/types.ts:851
kerning?	boolean	Whether kerning should be applied where supported.	TextBlockOptions.kerning	src/types.ts:886
lineHeight?	number	Line height in PDF points.	TextBlockOptions.lineHeight	src/types.ts:869
margin?	FlowMarginShorthand	CSS-like margin shorthand in PDF points.	FlowBlockSpacingOptions.margin	src/types.ts:1137
marginBottom?	number	Bottom margin in PDF points.	FlowBlockSpacingOptions.marginBottom	src/types.ts:1143
marginLeft?	number	Left margin in PDF points.	FlowBlockSpacingOptions.marginLeft	src/types.ts:1145
marginRight?	number	Right margin in PDF points.	FlowBlockSpacingOptions.marginRight	src/types.ts:1141
marginTop?	number	Top margin in PDF points.	FlowBlockSpacingOptions.marginTop	src/types.ts:1139
maxLines?	number	Maximum number of lines to render.	TextBlockOptions.maxLines	src/types.ts:884
strike?	boolean	Draws a strike-through line over the text.	TextBlockOptions.strike	src/types.ts:855
structure?	PdfStructureOptions	Additional structure metadata for tagged PDF output.	TextBlockOptions.structure	src/types.ts:895
tag?	| PdfTextStructureTag | "Artifact"	Structure tag used for tagged PDF output.	TextBlockOptions.tag	src/types.ts:893
underline?	boolean	Draws an underline beneath the text.	TextBlockOptions.underline	src/types.ts:853
verticalAlign?	VerticalAlign	Vertical alignment of the wrapped text within height. Requires height. Defaults to "top".	TextBlockOptions.verticalAlign	src/types.ts:882
wordSpacing?	number	Additional spacing between words in PDF points.	TextBlockOptions.wordSpacing	src/types.ts:867
writingMode?	"horizontal" | "vertical"	Text writing mode. "horizontal" (default) places characters left-to-right. "vertical" stacks characters top-to-bottom.	TextBlockOptions.writingMode	src/types.ts:891