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