Interface: TextOptions
Options for placing a single line of text.
Properties
| Property | Type | Description |
|---|---|---|
artifactType? | "Pagination" | "Layout" | "Page" | Artifact type classification for tagged PDF content. "Pagination" for headers/footers, "Layout" for typographic ornaments, "Page" for watermarks. Emitted as /Type in the /Artifact BMC/EMC pair. |
bold? | boolean | Selects the bold variant of font. For a built-in family (Helvetica, Times-Roman, Courier) this resolves to the matching bold base font. For a font family registered with PdfDocument.registerFontFamily it selects the registered bold face. Ignored when font is an explicit embedded-font handle. |
characterSpacing? | number | Additional spacing between characters in PDF points. |
color? | ColorInput | Color used for drawing, text, or highlighting. |
direction? | TextDirection | Text direction used for shaping and layout. |
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. |
fallbackFonts? | PdfFont[] | Fallback fonts used when the primary font lacks a glyph. |
font? | PdfFont | Font used to render text. |
fontSize? | number | Font size in PDF points. |
italic? | boolean | Selects the italic/oblique variant of font, following the same resolution rules as bold. Combine with bold for bold italic. |
kerning? | boolean | Whether kerning should be applied where supported. |
leading? | number | Text leading value in PDF points. |
strike? | boolean | Draws a strike-through line over the text. |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. |
tag? | PdfTextStructureTag | "Artifact" | Structure tag used for tagged PDF output. |
underline? | boolean | Draws an underline beneath the text. |
wordSpacing? | number | Additional spacing between words in PDF points. |
writingMode? | "horizontal" | "vertical" | Text writing mode. "horizontal" (default) places characters left-to-right. "vertical" stacks characters top-to-bottom. |
x | number | Horizontal position in PDF points. |
y | number | Vertical position in PDF points. |