API reference / Common / Engine types / LineAnnotation

Interface: LineAnnotation

A line annotation (Table 175).

The leader lengths and the caption offset are measured relative to the line, in PDF's sense (positive leaders extend above a line drawn left to right in y-up space), and are held as the file gives them; only the points are page space.

Properties

Property	Description
markup AnnotationMarkup	-
line [Point, Point] | null	/L — the line's start and end.
lineEndings AnnotationLineEndings | null	/LE.
interiorColor Color | null	/IC — the colour line endings are filled with.
leaderLength number | null	/LL — the leader lines' length.
leaderExtension number | null	/LLE — the leader line extensions' length.
leaderOffset number | null	/LLO — the leader line offset.
caption boolean | null	/Cap — whether contents is shown as a caption.
captionPosition | AnnotationCaptionPosition | null	/CP — where the caption sits.
captionOffset [number, number] | null	/CO — the caption's offset from its position: along the line, then across it.