InkAnnotationProperties

DsPdfJS API / InkAnnotationProperties

Type Alias: InkAnnotationProperties

InkAnnotationProperties = MarkupAnnotationProperties & object

Defines properies of a line annotation, that displays a single straight line on a page. When opened, it displays a pop-up window containing the text of the associated note.

Type Declaration

lineDashPattern?

optional lineDashPattern: number[]

The line dash pattern. Null means a solid line.

lineWidth?

optional lineWidth: number

The line width in points.

paths?

optional paths: Point[][]

The list of lists of points, in which each list of points represents a stroked path. The coordinates of points are relative to the upper left corner of the page's media box, with the Y (vertical) coordinates increasing from top to bottom.

Note that if the annotation is associated with more than one page, the media box of the first of those pages is used to calculate the coordinates.

type

type: "ink"