sempdf v1.9.1Interfaces
Interface: FlowNoteOptions
sempdf / FlowNoteOptions
Defined in: src/types.ts:1597
Options for placing a text note annotation through the flow layout API.
Extends
Omit<NoteAnnotationOptions,FlowBoxKeys>.FlowBlockSpacingOptions
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
contents | string | Annotation contents text. | NoteAnnotationOptions.contents | src/types.ts:3093 |
height? | number | Height in PDF points. | NoteAnnotationOptions.height | src/types.ts:3091 |
margin? | FlowMarginShorthand | CSS-like margin shorthand in PDF points. | FlowBlockSpacingOptions.margin | src/types.ts:1271 |
marginBottom? | number | Bottom margin in PDF points. | FlowBlockSpacingOptions.marginBottom | src/types.ts:1277 |
marginLeft? | number | Left margin in PDF points. | FlowBlockSpacingOptions.marginLeft | src/types.ts:1279 |
marginRight? | number | Right margin in PDF points. | FlowBlockSpacingOptions.marginRight | src/types.ts:1275 |
marginTop? | number | Top margin in PDF points. | FlowBlockSpacingOptions.marginTop | src/types.ts:1273 |
open? | boolean | Whether the note annotation is initially open. | NoteAnnotationOptions.open | src/types.ts:3095 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | NoteAnnotationOptions.structure | src/types.ts:3099 |
tag? | AnnotTagOrArtifact | Structure tag used for tagged PDF output. | NoteAnnotationOptions.tag | src/types.ts:3097 |
width? | number | Width override in PDF points. | - | src/types.ts:1604 |
x? | number | Horizontal position override in PDF points. | - | src/types.ts:1600 |
y? | number | Vertical position override in PDF points. | - | src/types.ts:1602 |