Class: ShapeAnnotation

PSPDFKit.Annotations.ShapeAnnotation

Base annotation type from which all shape annotations inherit. You can not directly instantiate from this type.

Shape annotations are used to draw different shapes on a page: lines, rectangles, ellipses, polylines and polygons.

Shapes which have start and ending points such as lines and polylines can have optional line start and line ending markers which can be filled with an optional fill color.

Shapes which define a closed area such as rectangles, ellipses and polygons, can have an optional fill color for the enclosed area.

Shapes lines can be solid or dashed with a dash pattern chosen from a predefined list.

Shape annotations without a fill color or with transparent fill color are only selectable around their visible lines or colored areas. This means that you can create a page full of these annotations while annotations behind them are still selectable.

Right now, shape annotations are implemented using SVG images. This behavior is subject to change.

For interacting with a shape annotation, please look at the subtypes:

Constructor

new PSPDFKit.Annotations.ShapeAnnotation(args)

Base annotation type for all shape annotations.

Parameters:
Name Type Description
args Object

An object of the members.

Example

Create a shape annotation (line) that displays a line

const annotation = new PSPDFKit.Annotations.LineAnnotation({
  pageIndex: 0,
  startPoint: new PSPDFKit.Geometry.Point({ x: 95, y: 5 }),
  endPoint: new PSPDFKit.Geometry.Point({ x: 5,  y: 95}),
  strokeWidth: 4
});

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:

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

strokeWidth: number

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

updatedAt: Date

The date of last annotation update.

Type:
  • Date