Skip to content

a11ydocs v1.7.0


a11ydocs / TableCellDefinition

Interface: TableCellDefinition

Defined in: src/types.ts:2034

Detailed table cell object with span, header, scope, and structure options.

Properties

PropertyTypeDescriptionDefined in
align?TextAlignHorizontal text alignment for this cell, overriding TableOptions.align.src/types.ts:2069
annotations?readonly ParagraphTextAnnotation[]Inline annotations anchored to substrings of the rendered cell text.src/types.ts:2054
background?ColorInputBackground fill for this cell, overriding headerBackground/zebra striping.src/types.ts:2071
bold?booleanRenders the cell text in the bold face of the table font (built-in variant or registered family face).src/types.ts:2061
color?ColorInputText color for this cell, overriding TableOptions.color.src/types.ts:2067
colSpan?numberNumber of columns spanned by the cell.src/types.ts:2050
font?PdfFontFont for this cell, overriding TableOptions.font. Accepts a built-in name, embedded handle, or registered family name (combined with the cell bold/italic flags).src/types.ts:2065
header?booleanCallback that returns header blocks for each page.src/types.ts:2044
italic?booleanRenders the cell text in the italic face of the table font (built-in variant or registered family face).src/types.ts:2063
rowSpan?numberNumber of rows spanned by the cell.src/types.ts:2048
runs?readonly InlineTextRun[]Inline rich-text runs rendered instead of text: mixed fonts, sizes, colors, bold/italic, underline/strike, and links wrap together inside the cell. Run styles omitted fall back to the cell, then table, style.src/types.ts:2042
scope?TableHeaderScopeSearch scope used when finding related structure elements.src/types.ts:2046
structure?PdfStructureOptionsAdditional structure metadata for tagged PDF output.src/types.ts:2052
text?stringText content to render or inspect. Either text or runs must be provided.src/types.ts:2036
verticalAlign?VerticalAlignVertical alignment of this cell's content within the row height, overriding TableOptions.verticalAlign.src/types.ts:2059

Released under the ISC license.