Interface: FlowHighlightOptions
Options for placing a highlight annotation through the flow layout API.
Extends
Omit<HighlightAnnotationOptions,"x"|"y"|"width">.FlowBlockSpacingOptions
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
color? | ColorInput | Color used for drawing, text, or highlighting. | HighlightAnnotationOptions.color |
height | number | Height in PDF points. | HighlightAnnotationOptions.height |
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 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | HighlightAnnotationOptions.structure |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | HighlightAnnotationOptions.tag |
width? | number | Width override in PDF points. | - |
x? | number | Horizontal position override in PDF points. | - |
y? | number | Vertical position override in PDF points. | - |