sempdf v1.9.1Interfaces
Interface: TemplateBlockControls
sempdf / TemplateBlockControls
Defined in: src/types.ts:2198
Pagination controls carried by every template block. Applied by the document-level template paginator (PdfDocument.renderTemplate). Merged into TemplateBlock by intersection so each block type gains them without redeclaring.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
anchor? | readonly | string | Registers a named destination at this block's page, referenceable by a TemplateCrossRefBlock. The name must be unique within the template. | src/types.ts:2216 |
breakAfter? | readonly | boolean | Force a page break (or advance to the next column) after this block. | src/types.ts:2205 |
breakBefore? | readonly | boolean | Force a page break (or advance to the next column) before this block, unless the flow cursor is already at the top of a fresh region. | src/types.ts:2203 |
footnote? | readonly | string | Footnote text anchored to this block. A numbered marker is appended to the block (for text blocks: heading/paragraph), and the note is rendered at the bottom of the page the block lands on. Notes are numbered document-wide in reading order. | src/types.ts:2223 |
keepTogether? | readonly | boolean | Keep this block whole — never split its content across a page or column boundary. Paragraphs, which may otherwise split line-by-line across columns, are placed as a unit instead. | src/types.ts:2211 |