Class: ImageAnnotation

PSPDFKit.Annotations.ImageAnnotation

Image annotations are images that are added to a PDF document.

Constructor

new PSPDFKit.Annotations.ImageAnnotation(args)

Display an image annotation, which represent an images in a PDF file.

Parameters:
Name Type Description
args Object

An object of the members.

Example

Create an image annotation

const annotation = new PSPDFKit.Annotations.ImageAnnotation({
  pageIndex: 0,
  contentType: "image/jpeg",
  imageAttachmentId: "abc123",
  description: "Example Image Annotation",
  boundingBox: new PSPDFKit.Geometry.Rect({
    left: 10,
    top: 20,
    width: 150,
    height: 150,
  }),
});

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:

contentType: string

The content type of the connected attachment binary data.

We currently support:

  • image/jpeg
  • image/png
  • application/pdf
Type:
  • string

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) description: string

A description of the image content.

Type:
  • string

(nullable) fileName: string

The file name of the attached file.

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

imageAttachmentId: string

The attachment identifier of the image. It holds the image data as binary.

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

rotation: number

The counter-clockwise rotation value in degree relative to the rotated PDF page. Inserting an annotation with a rotation value of 0 will make it appear in the same direction as the UI appears, when no PSPDFKit.ViewState#pagesRotation is set.

Can either be 0°, 90°, 180°, or 270°. Multiple or negative values are normalized to this interval.

Type:
  • number
Default Value:
  • 0

rotation: number

The counter-clockwise rotation value in degree relative to the rotated PDF page. Inserting an annotation with a rotation value of 0 will make it appear in the same direction as the UI appears, when no PSPDFKit.ViewState#pagesRotation is set.

Can either be 0°, 90°, 180°, or 270°. Multiple or negative values are normalized to this interval.

Type:
  • number
Default Value:
  • 0

updatedAt: Date

The date of last annotation update.

Type:
  • Date