Appearance
a11ydocs / TableOptions
Interface: TableOptions
Defined in: src/types.ts:2086
Options for rendering tagged tables.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
align? | TextAlign | Horizontal alignment for laid-out content. | src/types.ts:2120 |
borderColor? | ColorInput | Color of the cell grid lines. Setting this (or borderWidth) draws a border around every cell. Drawn as an artifact (not part of the structure tree). | src/types.ts:2141 |
borderWidth? | number | Width of the cell grid lines in PDF points. Defaults to 0.75 when borderColor is set. | src/types.ts:2143 |
cellPadding? | number | Padding inside table cells in PDF points. | src/types.ts:2100 |
characterSpacing? | number | Additional spacing between characters in PDF points. | src/types.ts:2114 |
color? | ColorInput | Color used for drawing, text, or highlighting. | src/types.ts:2112 |
columnWidths? | readonly number[] | Explicit table column widths in PDF points. | src/types.ts:2094 |
direction? | TextDirection | Text direction used for shaping and layout. | src/types.ts:2108 |
fallbackFonts? | PdfFont[] | Fallback fonts used when the primary font lacks a glyph. | src/types.ts:2106 |
font? | PdfFont | Font used to render text. | src/types.ts:2104 |
fontSize? | number | Font size in PDF points. | src/types.ts:2110 |
headerBackground? | ColorInput | Background fill behind header cells (header rows/columns and cells marked header: true). | src/types.ts:2145 |
headerColumns? | number | Number of leading columns treated as table headers. | src/types.ts:2098 |
headerRows? | number | Number of leading rows treated as table headers. | src/types.ts:2096 |
kerning? | boolean | Whether kerning should be applied where supported. | src/types.ts:2128 |
lineHeight? | number | Line height in PDF points. | src/types.ts:2118 |
rowGap? | number | Gap between table rows in PDF points. | src/types.ts:2102 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | src/types.ts:2130 |
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:2135 |
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:2126 |
width | number | Width in PDF points. | src/types.ts:2092 |
wordSpacing? | number | Additional spacing between words in PDF points. | src/types.ts:2116 |
x | number | Horizontal position in PDF points. | src/types.ts:2088 |
y | number | Vertical position in PDF points. | src/types.ts:2090 |
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:2150 |