sempdf v1.9.1Interfaces
Interface: TableOptions
sempdf / TableOptions
Defined in: src/types.ts:2617
Options for rendering tagged tables.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
align? | TextAlign | Horizontal alignment for laid-out content. | src/types.ts:2662 |
borderColor? | ColorInput | Color of the border lines. Setting this (or borderWidth, or borders) draws borders. Drawn as an artifact (not part of the structure tree). Defaults to a medium gray when borders are enabled without a color. | src/types.ts:2683 |
borders? | TableBorderStyle | Which border lines to draw: - "all" — full grid around every cell (default when a border color/width is set). - "horizontal" — horizontal rules between rows plus top and bottom edges; no vertical lines. - "outer" — a single frame around the whole table. - "none" — no borders, even if borderColor/borderWidth are set. When omitted, defaults to "all" if borderColor/borderWidth is set, otherwise "none". | src/types.ts:2695 |
borderWidth? | number | Width of the border lines in PDF points. Defaults to 0.75 when borders are enabled. | src/types.ts:2685 |
cellPadding? | number | Padding inside table cells in PDF points. | src/types.ts:2642 |
characterSpacing? | number | Additional spacing between characters in PDF points. | src/types.ts:2656 |
color? | ColorInput | Color used for drawing, text, or highlighting. | src/types.ts:2654 |
columnWidths? | readonly number[] | "auto" | Table column widths in PDF points. Provide an explicit array (must sum to width), or "auto" to size columns to their content — each column takes its natural un-wrapped width scaled to fill width, shrinking toward its longest-word width when content is too wide. Defaults to equal columns. | src/types.ts:2630 |
direction? | TextDirection | Text direction used for shaping and layout. | src/types.ts:2650 |
fallbackFonts? | PdfFont[] | Fallback fonts used when the primary font lacks a glyph. | src/types.ts:2648 |
font? | PdfFont | Font used to render text. | src/types.ts:2646 |
fontSize? | number | Font size in PDF points. | src/types.ts:2652 |
footerRows? | number | Number of trailing rows treated as a table footer. When a table is split across pages by the template paginator, these rows repeat at the bottom of every slice (mirroring how headerRows repeat at the top). Defaults to 0. | src/types.ts:2638 |
headerBackground? | ColorInput | Background fill behind header cells (header rows/columns and cells marked header: true). | src/types.ts:2697 |
headerColumns? | number | Number of leading columns treated as table headers. | src/types.ts:2640 |
headerRows? | number | Number of leading rows treated as table headers. | src/types.ts:2632 |
kerning? | boolean | Whether kerning should be applied where supported. | src/types.ts:2670 |
lineHeight? | number | Line height in PDF points. | src/types.ts:2660 |
rowGap? | number | Gap between table rows in PDF points. | src/types.ts:2644 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | src/types.ts:2672 |
summary? | string | Table summary for accessibility (/Summary attribute on the table structure element). Provides a description of the table for screen readers. | src/types.ts:2677 |
verticalAlign? | VerticalAlign | Vertical alignment of each cell's content within its row height. Applies to cells shorter than the tallest cell in the row. Defaults to "top". Can be overridden per cell via TableCellDefinition.verticalAlign. | src/types.ts:2668 |
width | number | Width in PDF points. | src/types.ts:2623 |
wordSpacing? | number | Additional spacing between words in PDF points. | src/types.ts:2658 |
x | number | Horizontal position in PDF points. | src/types.ts:2619 |
y | number | Vertical position in PDF points. | src/types.ts:2621 |
zebra? | boolean | ColorInput | Alternate-row striping for body rows: true fills every second body row with a light gray, or pass a color. Header rows are not striped. | src/types.ts:2702 |