Appearance
zeropdf / FlowRichTextOptions
Interface: FlowRichTextOptions
Defined in: src/types.ts:1172
Options for placing a paragraph of inline rich-text runs through the flow layout API. Position and width are supplied by the flow cursor; the remaining fields mirror RichTextOptions.
Extends
Omit<RichTextOptions,"x"|"y"|"width">.FlowBlockSpacingOptions
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
align? | "left" | "center" | "right" | "justify" | Horizontal alignment of each line. Defaults to "left". Ignored in vertical mode. | RichTextOptions.align | src/types.ts:958 |
blockAlign? | "left" | "center" | "right" | Alignment of the block inside the flow column. | - | src/types.ts:1177 |
blockWidth? | number | Optional width for the flow text block within the flow column. | - | src/types.ts:1175 |
color? | ColorInput | Default color for runs that omit one. | RichTextOptions.color | src/types.ts:986 |
direction? | TextDirection | Reading direction for the runs. "auto" detects from the run text. Right-to-left lays each line out from the right edge; this is line-level direction, not full mixed-direction bidirectional reordering. | RichTextOptions.direction | src/types.ts:975 |
font? | PdfFont | Default font for runs that omit one. | RichTextOptions.font | src/types.ts:982 |
fontSize? | number | Default font size for runs that omit one. | RichTextOptions.fontSize | src/types.ts:984 |
height? | number | Box height in PDF points. 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. Horizontal mode only. | RichTextOptions.height | src/types.ts:964 |
kerning? | boolean | Default kerning behavior for runs that omit it. | RichTextOptions.kerning | src/types.ts:988 |
lineHeight? | number | Line height in PDF points (column spacing in vertical mode). Defaults to 1.2 × the largest run font size. | RichTextOptions.lineHeight | src/types.ts:956 |
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 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | RichTextOptions.structure | src/types.ts:992 |
tag? | | PdfTextStructureTag | "Artifact" | Structure tag used for tagged PDF output. Defaults to "P". | RichTextOptions.tag | src/types.ts:990 |
verticalAlign? | VerticalAlign | Vertical alignment of the wrapped runs within height. Requires height. Defaults to "top". Horizontal mode only. | RichTextOptions.verticalAlign | src/types.ts:969 |
writingMode? | "horizontal" | "vertical" | Writing mode. "horizontal" (default) flows runs left-to-right and wraps onto new lines. "vertical" stacks the runs top-to-bottom in one column. | RichTextOptions.writingMode | src/types.ts:980 |