Class: WidgetAnnotation

PSPDFKit.Annotations.WidgetAnnotation

Widget annotations are part of PDF forms and used to position form elements, linked to PSPDFKit.FormFields.FormFields, on a page. To know how a widget is rendered also depends on the linked form field.

Widget annotations are currently read only at PSPDFKit for Web.

Constructor

new PSPDFKit.Annotations.WidgetAnnotation(args)

Draw form elements, linked to PSPDFKit.FormFields.FormFields, on a page.

Parameters:
Name Type Description
args Object

An object of the members.

Extends

Members




Members

(nullable) backgroundColor: PSPDFKit.Color

Optional background color that will fill the bounding box.

Type:
Default Value:
  • null

(nullable) borderColor: PSPDFKit.Color

Optional border color that will be drawn at the border of the bounding box.

Type:
Default Value:
  • null

(nullable) borderStyle: string

Optional border style used for the border of the bounding box. Valid options are:

  • solid
  • dashed
  • beveled
  • inset
  • underline
Type:
  • string
Default Value:
  • null

(nullable) borderWidth: number

Optional border width in PDF pixels, that will be used for the border of the bounding box.

Type:
  • number
Default Value:
  • null

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

(nullable) fontColor: PSPDFKit.Color

Optional font color.

Type:
Default Value:
  • null

formFieldName: string

The PSPDFKit.FormFields.FormField#name of the linked form field. Based on the type of the field, a different element will be rendered

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

updatedAt: Date

The date of last annotation update.

Type:
  • Date