Class: AnnotationBase

Base class for all annotation models.

Extended by

• PopupAnnotation
• MarkupAnnotation
• WidgetAnnotation

Properties

annotationName

annotationName: string

Annotation name (NM entry).

---

annotationType

annotationType: AnnotationTypeCode

Annotation type.

---

appearanceColor?

optional appearanceColor: string

Appearance color.

---

borderStyle?

optional borderStyle: object

Annotation's border style.

dashArray?

optional dashArray: number[]

Border dash pattern. Used when the border style is dashed.

horizontalCornerRadius

horizontalCornerRadius: number

style

style: number

Border style. Possible values: 1 - solid style (default), 2 - dashed style.

verticalCornerRadius

verticalCornerRadius: number

width

width: number

Border width.

---

color?

optional color: string

Annotation color.

---

contents?

optional contents: string

The text (or rich text) string that shall be displayed in the pop-up when the annotation is opened.

---

convertToContent?

optional convertToContent: boolean

Indicates whether the annotation will be converted to content when the document is saved.

---

creationDate

creationDate: string

Creation date.

---

display?

optional display: "hidden" | "visible"

The field is used for compatibility with Adobe Acrobat Reader.

---

id

id: string

Annotation id.

---

invisibleFlag

invisibleFlag: boolean

true if the annotation is hidden.

---

irtAnnotations?

optional irtAnnotations: AnnotationBase[]

Internal helper property. Primary annotation's children annotations. Note, the array contains all children annotations, including annotations what is not direct descendant of the primary annotation.

---

isRichContents

isRichContents: boolean

Specifies whether or not the RichContent mode is used for the contents property.

---

locked

locked: boolean

Specifies whether the annotation can be deleted or its properties (including position and size) can be modified by the user.

Example

var viewer = new DsPdfViewer('#root', { renderInteractiveForms: true , supportApi: { apiUrl: 'api/pdf-viewer', webSocketUrl: false } });
viewer.addDefaultPanels();
viewer.addAnnotationEditorPanel();
viewer.addFormEditorPanel();
viewer.addReplyTool();
viewer.onAfterOpen.register(()=>{
	// Lock all text annotations after document open:
	const resultArr = await viewer.findAnnotation(1, // 1 - AnnotationTypeCode.TEXT
						  { findField: 'annotationType',
				  		    pageNumberConstraint: 1, findAll: true });
	viewer.updateAnnotations(0, resultArr.map((data)=> { data.annotation.locked = true; return data.annotation; }));
});
// Open Annotations.pdf
viewer.open('Annotations.pdf');

---

modificationDate

modificationDate: string

Modification date.

---

opacity?

optional opacity: number

Annotation opacity.

---

orderIndex

orderIndex: number

The field order index.

---

parentAnnotation?

optional parentAnnotation: AnnotationBase

Resolved reference to parent annotation.

---

parentId?

optional parentId: string

Parent annotation id for popup annotation.

---

popupId?

optional popupId: string

Popup id if any.

---

printableFlag

printableFlag: boolean

Specifies whether or not the annotation can be printed.

---

rect

rect: number[]

The annotation's bounds rectangle: [x1, y1, x2, y2]. (0, 0) is the bottom left corner of the page.

---

redacted

redacted: boolean

Indicates whether the current annotation has been redacted. Redacted annotations will be removed from the document after saving.

---

redactedBy

redactedBy: string

ID of the Redact annotation that was used to redact the current annotation.

---

referenceAnnotationId

referenceAnnotationId: string

Id of the primary annotation to which this annotation belongs. ("in reply to" value).

---

referenceType

referenceType: "R" | "Group"

R - this annotation is reply to the primary annotation specified by field referenceAnnotationId. Group - annotation should be grouped with primary annotation specified by field referenceAnnotationId.

---

rotate?

optional rotate: number

The number of degrees by which the annotation shall be rotated relative to the page.

---

sharedChanges?

optional sharedChanges: object

Hash object with information about users who change this annotation. key - user name value - UNIX UTC timestamp when changes were added.

Index Signature

[userName: string]: number

---

state?

optional state: AnnotationMarkedStateType | AnnotationReviewStateType

Beginning with PDF 1.5, Annotations may have author-specific state associated with them. The state is not specified in the annotation itself but in separate text annotation that refers to the original annotation by means of its 'IRT' ("in reply to") entry.

---

stateModel?

optional stateModel: AnnotationStateModel

The state model corresponding to state.

---

subject

subject: string

Text representing a short description of the subject being addressed by the annotation. The 'subject' is the meta information property and it can be used to group, sort or filter annotations.

---

subtype

subtype: AnnotationTypeName

Annotation sub-type. Possible values are: 'Text', 'Link', 'FreeText', 'Line', 'Square', 'Circle', 'Polygon', 'PolyLine', 'Highlight', 'Underline', 'Squiggly', 'Strikeout', 'Stamp', 'Caret', 'Ink', 'Popup', 'FileAttachment', 'Sound', 'Movie', 'Widget', 'Screen', 'PrinterMark', 'TrapNet', 'WaterMark', 'Redact', 'Signature', 'ThreadBead', 'RadioButton', 'Checkbox', 'PushButton', 'Choice', 'TextWidget', 'RichMedia'

---

textAlignment

textAlignment: TextAlignmentType

The alignment of the text.

---

title

title: string

The text label that shall be displayed in the title bar of the annotation's popup when open and active. This entry shall identify the user who added the annotation.