Constructor
Underline markup annotation.
Parameters:
Name | Type | Description |
---|---|---|
args |
Object | An object of the members. |
Example
Create a underline annotation
const rects = PSPDFKit.Immutable.List([
new PSPDFKit.Geometry.Rect({ left: 10, top: 10, width: 200, height: 10 }),
new PSPDFKit.Geometry.Rect({ left: 10, top: 25, width: 200, height: 10 })
]);
const annotation = new PSPDFKit.Annotations.UnderlineAnnotation({
pageIndex: 0,
rects: rects,
boundingBox: PSPDFKit.Geometry.Rect.union(rects)
});
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:
A PSPDFKit.Color for the markup.
Type:
- Inherited From:
- Default Value:
- Color.BLACK
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:
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 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
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 list of rects where the annotation is drawn. This is necessary to display a markup annotation on multiple lines.
The boundingBox
should be set to the union of this list.
Type:
- Inherited From:
- Default Value:
- PSPDFKit.Immutable.List() Empty list
The date of last annotation update.
Type:
- Date
- Inherited From: