Appearance
a11ydocs / FlowFreeTextOptions
Interface: FlowFreeTextOptions
Defined in: src/types.ts:1339
Options for placing a free-text annotation through the flow layout API.
Extends
Omit<FreeTextAnnotationOptions,"x"|"y"|"width">.FlowBlockSpacingOptions
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
borderWidth? | number | Annotation or field border width in PDF points. | FreeTextAnnotationOptions.borderWidth | src/types.ts:2532 |
color? | ColorInput | Color used for drawing, text, or highlighting. | FreeTextAnnotationOptions.color | src/types.ts:2530 |
font? | FontName | Font used to render text. | FreeTextAnnotationOptions.font | src/types.ts:2526 |
fontSize? | number | Font size in PDF points. | FreeTextAnnotationOptions.fontSize | src/types.ts:2528 |
height | number | Height in PDF points. | FreeTextAnnotationOptions.height | src/types.ts:2522 |
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 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | FreeTextAnnotationOptions.structure | src/types.ts:2536 |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | FreeTextAnnotationOptions.tag | src/types.ts:2534 |
text | string | Text content to render or inspect. | FreeTextAnnotationOptions.text | src/types.ts:2524 |
width? | number | Width override in PDF points. | - | src/types.ts:1346 |
x? | number | Horizontal position override in PDF points. | - | src/types.ts:1342 |
y? | number | Vertical position override in PDF points. | - | src/types.ts:1344 |