Annotation name (NM entry).
Annotation type.
Optional
appearanceAppearance color.
Optional
borderAnnotation's border style.
Optional
dashBorder dash pattern. Used when the border style is dashed.
Border style. Possible values: 1 - solid style (default), 2 - dashed style.
Border width.
Optional
colorAnnotation color.
Optional
contentsThe text (or rich text) string that shall be displayed in the pop-up when the annotation is opened.
Optional
convertIndicates whether the annotation will be converted to content when the document is saved.
Creation date.
Optional
displayThe field is used for compatibility with Adobe Acrobat Reader.
Indicates if annotation has associated popup annotation.
Annotation id.
Optional
interiorInterior color.
true if the annotation is hidden.
Optional
irtInternal 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.
Specifies whether or not the RichContent mode is used for the contents property.
Specifies whether the annotation can be deleted or its properties (including position and size) can be modified by the user.
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');
Modification date.
Optional
opacityAnnotation opacity.
The field order index.
Optional
parentResolved reference to parent annotation.
Optional
parentParent annotation id for popup annotation.
Popup annotation identifier.
Specifies whether or not the annotation can be printed.
The annotation's bounds rectangle: [x1, y1, x2, y2]. (0, 0) is the bottom left corner of the page.
Indicates whether the current annotation has been redacted. Redacted annotations will be removed from the document after saving.
ID of the Redact annotation that was used to redact the current annotation.
Id of the primary annotation to which this annotation belongs. ("in reply to" value).
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.
Optional
rotateThe number of degrees by which the annotation shall be rotated relative to the page.
Optional
sharedHash object with information about users who change this annotation. key - user name value - UNIX UTC timestamp when changes were added.
Optional
stateBeginning 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.
Optional
stateThe state model corresponding to state.
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.
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'
The alignment of the text.
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.
PolyLine vertices points.
PolyLine annotation.