Skip to content

a11ydocs v1.7.0


a11ydocs / UnderlineAnnotationOptions

Interface: UnderlineAnnotationOptions

Defined in: src/types.ts:2429

Options for creating an underline text-markup annotation. The annotation draws a solid underline beneath the rectangle defined by x/y/width/height (the quad runs along the bottom edge of the rect).

Properties

PropertyTypeDescriptionDefined in
color?ColorInputColor used for the underline stroke. Defaults to black.src/types.ts:2439
heightnumberHeight in PDF points.src/types.ts:2437
structure?PdfStructureOptionsAdditional structure metadata for tagged PDF output.src/types.ts:2443
tag?"Annot" | "Artifact"Structure tag used for tagged PDF output.src/types.ts:2441
widthnumberWidth in PDF points.src/types.ts:2435
xnumberHorizontal position in PDF points.src/types.ts:2431
ynumberVertical position in PDF points.src/types.ts:2433

Released under the ISC license.