Type Alias: LineAnnotationProperties

type LineAnnotationProperties = MarkupAnnotationProperties & object;

Defines properties 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

end

end: Point;

The end point of the line. The coordinates of the point are relative to the upper left corner of the page's media box, with the Y (vertical) coordinates increasing from top to bottom.

horizontalTextOffset?

optional horizontalTextOffset?: number;

The horizontal offset along the annotation line from its midpoint, with a positive value indicating offset to the right and a negative value indicating offset to the left.

leaderLineOffset?

optional leaderLineOffset?: number;

A non-negative number representing the length of the leader line offset, which is the amount of empty space between the endpoints of the annotation and the beginning of the leader lines.

leaderLinesExtension?

optional leaderLinesExtension?: number;

A non-negative number representing the length of leader line extensions that extend from the line proper 180 degrees from the leader lines.

leaderLinesLength?

optional leaderLinesLength?: number;

The length of leader lines in default user space that extend from each endpoint of the line perpendicular to the line itself. A positive value means that the leader lines appear in the direction that is clockwise when traversing the line from its starting point to its ending point. A negative value indicates the opposite direction.

lineDashPattern?

optional lineDashPattern?: number[];

The line dash pattern. Null means a solid line.

lineEndingsFillColor?

optional lineEndingsFillColor?: Color;

The interior color with which to fill the annotation's line endings.

lineEndStyle?

optional lineEndStyle?: LineEndingStyle;

The style of line end.

lineStartStyle?

optional lineStartStyle?: LineEndingStyle;

The style of line start.

lineWidth?

optional lineWidth?: number;

The line width in points.

start

start: Point;

The start point of the line annotation. The coordinates of the point are relative to the upper left corner of the page's media box, with the Y (vertical) coordinates increasing from top to bottom.

textPosition?

optional textPosition?: LineAnnotationTextPosition;

The annotation's text positioning.

type

type: "line";

verticalTextOffset?

optional verticalTextOffset?: number;

The vertical offset perpendicular to the annotation line, with a positive value indicating a shift up and a negative value indicating a shift down.

See

LineAnnotation