sempdf v1.9.1Interfaces
Interface: FlowRichTextOptions
sempdf / FlowRichTextOptions
Defined in: src/types.ts:1443
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,FlowBoxKeys>.FlowBlockSpacingOptions
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
align? | BlockAlign | "justify" | Horizontal alignment of each line. Defaults to "left". Ignored in vertical mode. | RichTextOptions.align | src/types.ts:1086 |
artifactSubtype? | "Header" | "Footer" | "Watermark" | Optional artifact subtype, such as Header, Footer, or Watermark. | BmpImageOptions.artifactSubtype | src/types.ts:379 |
artifactType? | "Pagination" | "Layout" | "Page" | Artifact type written to the marked-content property dictionary. | BmpImageOptions.artifactType | src/types.ts:377 |
blockAlign? | BlockAlign | Alignment of the block inside the flow column. | - | src/types.ts:1448 |
blockWidth? | number | Optional width for the flow text block within the flow column. | - | src/types.ts:1446 |
color? | ColorInput | Default color for runs that omit one. | RichTextOptions.color | src/types.ts:1116 |
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:1103 |
fallbackFonts? | PdfFont[] | Fallback fonts for characters the run's font cannot encode. | RichTextOptions.fallbackFonts | src/types.ts:1112 |
font? | PdfFont | Default font for runs that omit one. | RichTextOptions.font | src/types.ts:1110 |
fontSize? | number | Default font size for runs that omit one. | RichTextOptions.fontSize | src/types.ts:1114 |
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:1092 |
kerning? | boolean | Default kerning behavior for runs that omit it. | RichTextOptions.kerning | src/types.ts:1118 |
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:1084 |
margin? | FlowMarginShorthand | CSS-like margin shorthand in PDF points. | FlowBlockSpacingOptions.margin | src/types.ts:1271 |
marginBottom? | number | Bottom margin in PDF points. | FlowBlockSpacingOptions.marginBottom | src/types.ts:1277 |
marginLeft? | number | Left margin in PDF points. | FlowBlockSpacingOptions.marginLeft | src/types.ts:1279 |
marginRight? | number | Right margin in PDF points. | FlowBlockSpacingOptions.marginRight | src/types.ts:1275 |
marginTop? | number | Top margin in PDF points. | FlowBlockSpacingOptions.marginTop | src/types.ts:1273 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | RichTextOptions.structure | src/types.ts:1122 |
tag? | TextTagOrArtifact | Structure tag used for tagged PDF output. Defaults to "P". | RichTextOptions.tag | src/types.ts:1120 |
verticalAlign? | VerticalAlign | Vertical alignment of the wrapped runs within height. Requires height. Defaults to "top". Horizontal mode only. | RichTextOptions.verticalAlign | src/types.ts:1097 |
writingMode? | WritingMode | 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:1108 |