Class: NoteAnnotation

PSPDFKit.Annotations.NoteAnnotation

Note annotations are "sticky notes" attached to a point in the PDF document. They are represented as markers and each of them as an icon associated to it. Its text content is revealed on selection.

Constructor

new PSPDFKit.Annotations.NoteAnnotation(args)

A text note that will be rendered inside the bounding box.

Parameters:
Name Type Description
args Object

An object of the members.

Example

Create a note annotation

const annotation = new PSPDFKit.Annotations.NoteAnnotation({
  pageIndex: 0,
  text: "Remember the milk",
  boundingBox: new PSPDFKit.Geometry.Rect({ left: 10, top: 20, width: 30, height: 40 }),
});

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:

Background color that will fill the complete bounding box.

Type:
Default Value:
  • new Color({ r: 255, g: 216, b: 63 }) - yellow

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

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

An optional note that can be set on any annotation.

This value is not displayed in the PSPDFKit for Web UI yet.

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

text: string

The note contents in plain text formats. We don't support rich text formatting in the text field.

Type:
  • string
Default Value:
  • ""

updatedAt: Date

The date of last annotation update.

Type:
  • Date