Interface: FlowTextOptions
Options for placing paragraphs or text blocks through the flow layout API.
Extends
Omit<TextBlockOptions,"x"|"y"|"width">.FlowBlockSpacingOptions
Extended by
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
align? | TextAlign | Horizontal alignment for laid-out content. | TextBlockOptions.align |
blockAlign? | "left" | "center" | "right" | Alignment of the block inside the flow column. | - |
blockWidth? | number | Optional width for the flow text block within the flow column. | - |
bold? | boolean | Selects the bold variant of font. See TextOptions.bold. | TextBlockOptions.bold |
characterSpacing? | number | Additional spacing between characters in PDF points. | TextBlockOptions.characterSpacing |
color? | ColorInput | Color used for drawing, text, or highlighting. | TextBlockOptions.color |
direction? | TextDirection | Text direction used for shaping and layout. | TextBlockOptions.direction |
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 |
fallbackFonts? | PdfFont[] | Fallback fonts used when the primary font lacks a glyph. | TextBlockOptions.fallbackFonts |
font? | PdfFont | Font used to render text. | TextBlockOptions.font |
fontSize? | number | Font size in PDF points. | TextBlockOptions.fontSize |
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 |
italic? | boolean | Selects the italic variant of font. See TextOptions.italic. | TextBlockOptions.italic |
kerning? | boolean | Whether kerning should be applied where supported. | TextBlockOptions.kerning |
lineHeight? | number | Line height in PDF points. | TextBlockOptions.lineHeight |
margin? | FlowMarginShorthand | CSS-like margin shorthand in PDF points. | FlowBlockSpacingOptions.margin |
marginBottom? | number | Bottom margin in PDF points. | FlowBlockSpacingOptions.marginBottom |
marginLeft? | number | Left margin in PDF points. | FlowBlockSpacingOptions.marginLeft |
marginRight? | number | Right margin in PDF points. | FlowBlockSpacingOptions.marginRight |
marginTop? | number | Top margin in PDF points. | FlowBlockSpacingOptions.marginTop |
maxLines? | number | Maximum number of lines to render. | TextBlockOptions.maxLines |
strike? | boolean | Draws a strike-through line over the text. | TextBlockOptions.strike |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | TextBlockOptions.structure |
tag? | | PdfTextStructureTag | "Artifact" | Structure tag used for tagged PDF output. | TextBlockOptions.tag |
underline? | boolean | Draws an underline beneath the text. | TextBlockOptions.underline |
verticalAlign? | VerticalAlign | Vertical alignment of the wrapped text within height. Requires height. Defaults to "top". | TextBlockOptions.verticalAlign |
wordSpacing? | number | Additional spacing between words in PDF points. | TextBlockOptions.wordSpacing |
writingMode? | "horizontal" | "vertical" | Text writing mode. "horizontal" (default) places characters left-to-right. "vertical" stacks characters top-to-bottom. | TextBlockOptions.writingMode |