Interface: FlowNoteOptions
Options for placing a text note annotation through the flow layout API.
Extends
Omit<NoteAnnotationOptions,"x"|"y"|"width">.FlowBlockSpacingOptions
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
contents | string | Annotation contents text. | NoteAnnotationOptions.contents |
height? | number | Height in PDF points. | NoteAnnotationOptions.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 |
open? | boolean | Whether the note annotation is initially open. | NoteAnnotationOptions.open |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | NoteAnnotationOptions.structure |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | NoteAnnotationOptions.tag |
width? | number | Width override in PDF points. | - |
x? | number | Horizontal position override in PDF points. | - |
y? | number | Vertical position override in PDF points. | - |