PdfWidgetAnnotation API in JavaScript PDF API control

PdfWidgetAnnotation class represents the widget annotation objects.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access first page
let page: PdfPage = document.getPage(0);
// Access the annotation at index 0
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

Properties

author string

Gets the author of the annotation.

backColor number[]

Gets the back color of the annotation.

border PdfAnnotationBorder

Gets the border of the annotation.

borderColor number[]

Gets the border color of the annotation.

bounds Object

Gets the bounds of the annotation.

caption PdfAnnotationCaption

Gets the caption of the annotation.

color number[]

Gets the fore color of the annotation.

creationDate Date

Gets the creation date of the annotation.

flags PdfAnnotationFlag

Gets the flags of the annotation.

flatten boolean

Gets the boolean flag indicating whether the annotation have been flattened or not.

flattenPopups boolean

Gets the boolean flag indicating whether annotation’s popup have been flattened or not.

font PdfFont

Gets the font of the item.

highlightMode PdfHighlightMode

Gets the highlight mode of the annotation.

innerColor number[]

Gets the inner color of the annotation.

layer PdfLayer

Gets the PdfLayer of the annotation.

modifiedDate Date

Gets the modification date of the annotation.

name string

Gets the name of the annotation.

opacity number

Gets the opacity of the annotation.

page PdfPage

Gets the page object (Read only).

rotate number

Gets the rotation angle of the annotation.

rotationAngle PdfRotationAngle

Gets the rotation of the annotation.

subject string

Gets the subject of the annotation.

text string

Gets the text of the annotation.

textAlignment PdfTextAlignment

Gets the text alignment of the annotation.

visibility PdfFormFieldVisibility

Gets the visibility.

Methods

getValues

Gets the values associated with the specified key.

Returns string[]

setAppearance

Set the boolean flag to create a new appearance stream for annotations.

Returns void

setValues

Sets the values associated with the specified key.

Returns void