Skip to content

a11ydocs v1.7.0


a11ydocs / SquigglyAnnotationOptions

Interface: SquigglyAnnotationOptions

Defined in: src/types.ts:2472

Options for creating a squiggly text-markup annotation. Draws a wavy underline beneath the rectangle (commonly used to flag spelling or grammar concerns).

Properties

PropertyTypeDescriptionDefined in
color?ColorInputColor used for the squiggly stroke. Defaults to red.src/types.ts:2482
heightnumberHeight in PDF points.src/types.ts:2480
structure?PdfStructureOptionsAdditional structure metadata for tagged PDF output.src/types.ts:2486
tag?"Annot" | "Artifact"Structure tag used for tagged PDF output.src/types.ts:2484
widthnumberWidth in PDF points.src/types.ts:2478
xnumberHorizontal position in PDF points.src/types.ts:2474
ynumberVertical position in PDF points.src/types.ts:2476

Released under the ISC license.