Class: UnderlineAnnotation

PSPDFKit.Annotations.UnderlineAnnotation

An underline markup annotation. Please refer to PSPDFKit.Annotations.MarkupAnnotation for more information.

Constructor

new PSPDFKit.Annotations.UnderlineAnnotation(args)

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

boundingBox: PSPDFKit.Geometry.Rect

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:

A PSPDFKit.Color for the markup.

Type:
Default Value:
  • Color.BLACK

createdAt: Date

The date of the annotation creation.

Type:
  • Date

(nullable) creatorName: string

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

(nullable) customData: Object

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
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"
  }
});

id: string

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

(nullable) name: string

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

noPrint: boolean

The annotation flag that prevents the annotation from being printed.

Type:
  • boolean
Default Value:
  • false

noView: boolean

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
Default Value:
  • false

opacity: number

A transparency value that is applied to the complete annotation. The value is capped between 0 and 1 inclusive.

Type:
  • number
Default Value:
  • 1

pageIndex: number

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

(nullable) pdfObjectId: number

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
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:
Default Value:
  • PSPDFKit.Immutable.List() Empty list

updatedAt: Date

The date of last annotation update.

Type:
  • Date