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 may only be created or modified if the Form Creator component is present in the license.

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) additionalActions: PSPDFKit.WidgetAnnotationAdditionalActions

Optional actions to execute when an event is triggered.

Type:
Default Value:
  • null
Example

Adding an PSPDFKit.Actions.JavaScriptAction when the annotation is focused:

const widget = new PSPDFKit.Annotations.WidgetAnnotation({
  id: PSPDFKit.generateInstantId(),
  pageIndex: 0,
  formFieldName: "MyFormField",
  boundingBox: new PSPDFKit.Geometry.Rect({
    left: 100,
    top: 75,
    width: 200,
    height: 80
  }),
  additionalActions: {
    onFocus: new PSPDFKit.Actions.JavaScriptAction({
      script: "alert('onFocus')"
    })
  }
});

const form = new PSPDFKit.FormFields.TextFormField({
    name: "MyFormField",
    annotationIds: new PSPDFKit.Immutable.List([annotation.id]),
    value: "Text shown in the form field"
});

instance.create([widget, form])

(nullable) backgroundColor: PSPDFKit.Color

Optional background color that will fill the bounding box.

Type:
Default Value:
  • null

blendMode: PSPDFKit.BlendMode

The blend mode defines how the color of the annotation will be applied to its background.

Type:
Default Value:
  • "normal"

(nullable) borderColor: PSPDFKit.Color

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

Type:
Default Value:
  • null

(nullable) borderDashArray: Array.<number>

Optional dash pattern used to draw the border for dashed border style.

Type:
  • Array.<number>

(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:

(readonly) canSetGroup: boolean

This property defines whether the user has permission to edit the group of this annotation.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

Type:
  • boolean

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

(nullable) font: string

The name of the font family that should be used.

Fonts are client specific and determined during runtime. If a font is not found, we will automatically fall back to 'sans-serif'.

We test the following list at runtime. The first available font will be used as the default for all new widget annotations: Helvetica, Arial, Calibri, Century Gothic, Consolas, Courier, Dejavu Sans, Dejavu Serif, Georgia, Gill Sans, Impact, Lucida Sans, Myriad Pro, Open Sans, Palatino, Tahoma, Times New Roman, Trebuchet, Verdana, Zapfino, Comic Sans.

If the browser does not natively support the font, it's still possible to support it by providing the required font data using a custom stylesheet.

Type:
  • string
Default Value:
  • null

(nullable) fontColor: PSPDFKit.Color

Optional font color.

Type:
Default Value:
  • null

fontSize: number

Optional font size in page size pixels.

Type:
  • number
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

(readonly) group: string

This property is used to define the permission scope for this widget annotation. If you want to change the group, you should update the group property of the corresponding form field.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

Type:
  • string

hidden: boolean

If set, do not display or print the annotation or allow it to interact with the user.

Type:
  • boolean
Default Value:
  • false

horizontalAlign: 'left'|'center'|'right'

Optional horizontal text alignment.

Type:
  • 'left' | 'center' | 'right'
Default Value:
  • left

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

isBold: boolean

If true, the font will be bold if the font family supports this.

Type:
  • boolean
Default Value:
  • false

(readonly) isDeletable: boolean

This property defines whether this annotation can be deleted or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

Type:
  • boolean

(readonly) isEditable: boolean

This property defines whether this annotation can be edited or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

Type:
  • boolean

isItalic: boolean

If true, the font will be italic if the font family supports this.

Type:
  • boolean
Default Value:
  • false

locked: boolean

The annotation flag that prevents the annotation from being modified.

Type:
  • boolean
Default Value:
  • false

lockedContents: boolean

The annotation flag that prevents the annotation content from being modified.

Type:
  • boolean
Default Value:
  • false

(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

(nullable) note: string

An optional note that can be set on any annotation.

This value is displayed in the PSPDFKit for Web UI for all annotations except NoteAnnotation, TextAnnotation, WidgetAnnotation and CommentMarkerAnnotation.

Type:
  • string

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

readOnly: boolean

The annotation flag that makes the annotation read only.

Type:
  • boolean
Default Value:
  • false

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.

Note: Due to browser constraints, the rotation property is currently reset once the edit mode is enabled via the user interface.

Type:
  • number
Default Value:
  • 0

(nullable) subject: string

An optional annotation subject, representing a short description of the subject being addressed by the annotation. This property has no effect on the annotation rendering.

Type:
  • string

updatedAt: Date

The date of last annotation update.

Type:
  • Date

verticalAlign: 'top'|'center'|'bottom'

Optional vertical text alignment.

Type:
  • 'top' | 'center' | 'bottom'
Default Value:
  • null