Appearance
a11ydocs / FlowHighlightOptions
Interface: FlowHighlightOptions
Defined in: src/types.ts:1313
Options for placing a highlight annotation through the flow layout API.
Extends
Omit<HighlightAnnotationOptions,"x"|"y"|"width">.FlowBlockSpacingOptions
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
color? | ColorInput | Color used for drawing, text, or highlighting. | HighlightAnnotationOptions.color | src/types.ts:2417 |
height | number | Height in PDF points. | HighlightAnnotationOptions.height | src/types.ts:2415 |
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. | HighlightAnnotationOptions.structure | src/types.ts:2421 |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | HighlightAnnotationOptions.tag | src/types.ts:2419 |
width? | number | Width override in PDF points. | - | src/types.ts:1320 |
x? | number | Horizontal position override in PDF points. | - | src/types.ts:1316 |
y? | number | Vertical position override in PDF points. | - | src/types.ts:1318 |