Appearance
a11ydocs / ListOptions
Interface: ListOptions
Defined in: src/types.ts:1985
Options for rendering tagged ordered or unordered lists.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
align? | TextAlign | Horizontal alignment for laid-out content. | src/types.ts:2009 |
bullet? | string | Bullet text used for unordered list items. | src/types.ts:2017 |
characterSpacing? | number | Additional spacing between characters in PDF points. | src/types.ts:2003 |
color? | ColorInput | Color used for drawing, text, or highlighting. | src/types.ts:2001 |
direction? | TextDirection | Text direction used for shaping and layout. | src/types.ts:1997 |
fallbackFonts? | PdfFont[] | Fallback fonts used when the primary font lacks a glyph. | src/types.ts:1995 |
font? | PdfFont | Font used to render text. | src/types.ts:1993 |
fontSize? | number | Font size in PDF points. | src/types.ts:1999 |
indent? | number | List indentation in PDF points. | src/types.ts:2021 |
itemSpacing? | number | Vertical spacing between list items in PDF points. | src/types.ts:2019 |
kerning? | boolean | Whether kerning should be applied where supported. | src/types.ts:2011 |
labelGap? | number | Gap between list labels and item bodies in PDF points. | src/types.ts:2023 |
lineHeight? | number | Line height in PDF points. | src/types.ts:2007 |
ordered? | boolean | Whether to render the list with ordered labels. | src/types.ts:2013 |
startAt? | number | Starting number for ordered output. | src/types.ts:2015 |
width | number | Width in PDF points. | src/types.ts:1991 |
wordSpacing? | number | Additional spacing between words in PDF points. | src/types.ts:2005 |
x | number | Horizontal position in PDF points. | src/types.ts:1987 |
y | number | Vertical position in PDF points. | src/types.ts:1989 |