sempdf v1.9.1Interfaces
Interface: FlowHeadingOptions
sempdf / FlowHeadingOptions
Defined in: src/types.ts:1310
Flow text options plus heading-level configuration.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
align? | TextAlign | Horizontal alignment for laid-out content. | TextBlockOptions.align | src/types.ts:965 |
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. | FlowTextOptions.blockAlign | src/types.ts:1290 |
blockWidth? | number | Optional width for the flow text block within the flow column. | FlowTextOptions.blockWidth | src/types.ts:1288 |
bold? | boolean | Selects the bold variant of font. See TextOptions.bold. | TextBlockOptions.bold | src/types.ts:943 |
characterSpacing? | number | Additional spacing between characters in PDF points. | TextBlockOptions.characterSpacing | src/types.ts:959 |
color? | ColorInput | Color used for drawing, text, or highlighting. | TextBlockOptions.color | src/types.ts:957 |
direction? | TextDirection | Text direction used for shaping and layout. | TextBlockOptions.direction | src/types.ts:953 |
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:995 |
fallbackFonts? | PdfFont[] | Fallback fonts used when the primary font lacks a glyph. | TextBlockOptions.fallbackFonts | src/types.ts:951 |
font? | PdfFont | Font used to render text. | TextBlockOptions.font | src/types.ts:941 |
fontSize? | number | Font size in PDF points. | TextBlockOptions.fontSize | src/types.ts:955 |
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:971 |
highlight? | ColorInput | Background highlight color drawn behind the text. See TextOptions.highlight. | TextBlockOptions.highlight | src/types.ts:1011 |
horizontalScaling? | number | Horizontal glyph scaling percentage. See TextOptions.horizontalScaling. | TextBlockOptions.horizontalScaling | src/types.ts:1009 |
italic? | boolean | Selects the italic variant of font. See TextOptions.italic. | TextBlockOptions.italic | src/types.ts:945 |
kerning? | boolean | Whether kerning should be applied where supported. | TextBlockOptions.kerning | src/types.ts:980 |
level? | HeadingLevel | Heading level to render and tag. | - | src/types.ts:1312 |
lineHeight? | number | Line height in PDF points. | TextBlockOptions.lineHeight | src/types.ts:963 |
margin? | FlowMarginShorthand | CSS-like margin shorthand in PDF points. | FlowTextOptions.margin | src/types.ts:1271 |
marginBottom? | number | Bottom margin in PDF points. | FlowTextOptions.marginBottom | src/types.ts:1277 |
marginLeft? | number | Left margin in PDF points. | FlowTextOptions.marginLeft | src/types.ts:1279 |
marginRight? | number | Right margin in PDF points. | FlowTextOptions.marginRight | src/types.ts:1275 |
marginTop? | number | Top margin in PDF points. | FlowTextOptions.marginTop | src/types.ts:1273 |
maxLines? | number | Maximum number of lines to render. | TextBlockOptions.maxLines | src/types.ts:978 |
orphans? | number | Minimum number of lines to keep together at the bottom of a region before this paragraph is allowed to break across a column or page. If fewer than this many lines would remain at the bottom, the whole paragraph moves to the next region. Only applies to multi-column flows (single-column paragraphs are never split). Defaults to 1 (no constraint). Fractions are floored. | FlowTextOptions.orphans | src/types.ts:1298 |
renderMode? | TextRenderMode | Glyph painting mode. See TextOptions.renderMode. | TextBlockOptions.renderMode | src/types.ts:1003 |
rise? | number | Raises (+) or lowers (−) the baseline in PDF points. See TextOptions.rise. | TextBlockOptions.rise | src/types.ts:997 |
strike? | boolean | Draws a strike-through line over the text. | TextBlockOptions.strike | src/types.ts:949 |
strokeColor? | ColorInput | Stroke color for stroking render modes. See TextOptions.strokeColor. | TextBlockOptions.strokeColor | src/types.ts:1005 |
strokeWidth? | number | Stroke width for stroking render modes. See TextOptions.strokeWidth. | TextBlockOptions.strokeWidth | src/types.ts:1007 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | TextBlockOptions.structure | src/types.ts:989 |
subscript? | boolean | Renders the block as subscript. See TextOptions.subscript. | TextBlockOptions.subscript | src/types.ts:1001 |
superscript? | boolean | Renders the block as superscript. See TextOptions.superscript. | TextBlockOptions.superscript | src/types.ts:999 |
tag? | TextTagOrArtifact | Structure tag used for tagged PDF output. | TextBlockOptions.tag | src/types.ts:987 |
underline? | boolean | Draws an underline beneath the text. | TextBlockOptions.underline | src/types.ts:947 |
verticalAlign? | VerticalAlign | Vertical alignment of the wrapped text within height. Requires height. Defaults to "top". | TextBlockOptions.verticalAlign | src/types.ts:976 |
widows? | number | Minimum number of lines this paragraph must carry into a new region after a break, so a lone trailing line is never left stranded. Only applies to multi-column flows. Defaults to 1 (no constraint). Fractions are floored. | FlowTextOptions.widows | src/types.ts:1304 |
wordSpacing? | number | Additional spacing between words in PDF points. | TextBlockOptions.wordSpacing | src/types.ts:961 |
writingMode? | WritingMode | Text writing mode. "horizontal" (default) places characters left-to-right. "vertical" stacks characters top-to-bottom. | TextBlockOptions.writingMode | src/types.ts:985 |