Appearance
a11ydocs / FlowListOptions
Interface: FlowListOptions
Defined in: src/types.ts:1352
Options for placing a tagged list through the flow layout API.
Extends
Omit<ListOptions,"x"|"y"|"width">.FlowBlockSpacingOptions
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
align? | TextAlign | Horizontal alignment for laid-out content. | ListOptions.align | src/types.ts:2009 |
bullet? | string | Bullet text used for unordered list items. | ListOptions.bullet | src/types.ts:2017 |
characterSpacing? | number | Additional spacing between characters in PDF points. | ListOptions.characterSpacing | src/types.ts:2003 |
color? | ColorInput | Color used for drawing, text, or highlighting. | ListOptions.color | src/types.ts:2001 |
direction? | TextDirection | Text direction used for shaping and layout. | ListOptions.direction | src/types.ts:1997 |
fallbackFonts? | PdfFont[] | Fallback fonts used when the primary font lacks a glyph. | ListOptions.fallbackFonts | src/types.ts:1995 |
font? | PdfFont | Font used to render text. | ListOptions.font | src/types.ts:1993 |
fontSize? | number | Font size in PDF points. | ListOptions.fontSize | src/types.ts:1999 |
indent? | number | List indentation in PDF points. | ListOptions.indent | src/types.ts:2021 |
itemSpacing? | number | Vertical spacing between list items in PDF points. | ListOptions.itemSpacing | src/types.ts:2019 |
kerning? | boolean | Whether kerning should be applied where supported. | ListOptions.kerning | src/types.ts:2011 |
labelGap? | number | Gap between list labels and item bodies in PDF points. | ListOptions.labelGap | src/types.ts:2023 |
lineHeight? | number | Line height in PDF points. | ListOptions.lineHeight | src/types.ts:2007 |
margin? | FlowMarginShorthand | CSS-like margin shorthand in PDF points. | FlowBlockSpacingOptions.margin | src/types.ts:1137 |
marginBottom? | number | Bottom margin in PDF points. | FlowBlockSpacingOptions.marginBottom | src/types.ts:1143 |
marginLeft? | number | Left margin in PDF points. | FlowBlockSpacingOptions.marginLeft | src/types.ts:1145 |
marginRight? | number | Right margin in PDF points. | FlowBlockSpacingOptions.marginRight | src/types.ts:1141 |
marginTop? | number | Top margin in PDF points. | FlowBlockSpacingOptions.marginTop | src/types.ts:1139 |
ordered? | boolean | Whether to render the list with ordered labels. | ListOptions.ordered | src/types.ts:2013 |
startAt? | number | Starting number for ordered output. | ListOptions.startAt | src/types.ts:2015 |
width? | number | Width override in PDF points. | - | src/types.ts:1358 |
wordSpacing? | number | Additional spacing between words in PDF points. | ListOptions.wordSpacing | src/types.ts:2005 |
x? | number | Horizontal position override in PDF points. | - | src/types.ts:1354 |
y? | number | Vertical position override in PDF points. | - | src/types.ts:1356 |