Constructor
Display a straight line on a page.
Parameters:
Name | Type | Description |
---|---|---|
args |
Object | An object of the members. |
Example
Create a line annotation
const annotation = new PSPDFKit.Annotations.LineAnnotation({
pageIndex: 0,
startPoint: new PSPDFKit.Geometry.Point({ x: 95, y: 95}),
endPoint: new PSPDFKit.Geometry.Point({ x: 195, y: 195}),
boundingBox: new PSPDFKit.Geometry.Rect({
left: 90,
top: 90,
width: 200,
height: 200,
}),
});
Extends
Members
Members
Position of this annotation on the page. It's necessary that this spans all visible points of the annotation, otherwise hit testing and other features may not work.
Type:
- Inherited From:
The date of the annotation creation.
Type:
- Date
- Inherited From:
The name of the creator of the annotation. This is a general purpose string which can easily be spoofed and might not reflect the actual creator of the annotation.
Type:
- string
- Inherited From:
Annotations can store additional user-specified data.
PSPDFKit will not use or evaluate customData
in the UI directly.
You have full control over this property. For new annotations, this defaults to null.
customData will be stored as JSON through JSON.serialize()
and JSON.parse()
, and
so must be a plain JSON-serializable object.
Type:
- Object
- Inherited From:
Example
Adding a new PSPDFKit.Annotations.EllipseAnnotation with custom data attached:
const annotation = new PSPDFKit.Annotations.EllipseAnnotation({
pageIndex: 0,
boundingBox: new PSPDFKit.Geometry.Rect({
top: 10,
left: 10,
width: 100,
height: 100
}),
customData: {
circleId: "my-circle"
}
});
A point tuple with x and y coordinates of the line ending point.
If no ending point is provided, the annotation will not be visible.
Type:
A PSPDFKit.Color to fill the interior of closed shapes (ellipses, rectangles and polygons) or start and / or end line caps of open shapes (lines and polylines).
Type:
- Inherited From:
- Default Value:
- null
If set, do not display or print the annotation or allow it to interact with the user.
Type:
- boolean
- Inherited From:
- Default Value:
- false
A unique identifier to describe the annotation. When an annotation is created in the UI, the viewer has to generate a unique ID.
When changes are saved to the underlying annotation provider, we call PSPDFKit.Instance#ensureAnnotationSaved to make sure the annotation has been persisted from the provider.
Type:
- string
- Inherited From:
An object with start and / or end entries for line caps.
Line caps can have one of these values: "square", "circle", "diamond", "openArrow", "closedArrow", "butt", "reverseOpenArrow", "reverseClosedArrow" or "slash".
If the fillColor field is provided, its value is used as fill color for the line cap interior.
Type:
- LineCaps
An optional field that may be used to identify the annotation.
By default, we'll set that to the same value as the automatically generated PSPDFKit.Annotations.Annotation#id.
Type:
- string
- Inherited From:
The annotation flag that prevents the annotation from being printed.
Type:
- boolean
- Inherited From:
- Default Value:
- false
An optional note that can be set on any annotation.
This value is not displayed in the PSPDFKit for Web UI yet.
Type:
- string
- Inherited From:
The annotation flag that prevents the annotation from being rendered in the UI.
The annotation may still be part of the printed page, depending of the value of the PSPDFKit.Annotations.Annotation#noPrint flag.
Type:
- boolean
- Inherited From:
- Default Value:
- false
A transparency value that is applied to the complete annotation. The value is capped between 0 and 1 inclusive.
Type:
- number
- Inherited From:
- Default Value:
- 1
The page index on which the annotation is placed. It's important to notice that an annotation can only ever be on one page. If you create for example an ink annotation with lines on two pages, two annotation records will be created.
pageIndex
is zero-based and has a maximum value of totalPageCount - 1
.
Type:
- number
- Inherited From:
When the annotation is extracted directly from a PDF file, the pdfObjectId
refers to the
identifier that was used in the PDF document.
This ID is optional since newly created annotations using the SYNCProvider annotation provider
won't have a pdfObjectId
assigned.
Type:
- number
- Inherited From:
- Default Value:
- null
A point tuple with x and y coordinates of the line starting point.
If no starting point is provided, the annotation will not be visible.
Type:
A PSPDFKit.Color for the shape lines
Type:
- Inherited From:
- Default Value:
- Color.BLUE
Optional dash pattern used to draw the shape lines for dashed line style.
Type:
- Array.<number>
- Inherited From:
The width of the line in page size pixels. By default, we use values between 1 and 40 in the UI.
The stroke width will scale when you zoom in.
Type:
- number
- Inherited From:
- Default Value:
- 5
The date of last annotation update.
Type:
- Date
- Inherited From: