Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextAnnotation

Text annotation.

Hierarchy

Index

Properties

__stateVersion

__stateVersion: number

Internal property, used by control.

creationDate

creationDate: string

Creation date.

Optional display

display: "visible" | "hidden"

The field is used for compatibility with Adobe Acrobat Reader.

displayState

Internal helper property. The State to which original annotation is set by current user.

hasPopup

hasPopup: boolean

Indicates if annotation has associated popup annotation.

id

id: string

Annotation id.

invisibleFlag

invisibleFlag: boolean

True when annotation is not renderable.

Optional irtAnnotations

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.

modificationDate

modificationDate: string

Modification date.

name

name: "Comment" | "Key" | "Note" | "Help" | "NewParagraph" | "Paragraph" | "Insert"

Icon name.

open

open: boolean

Initially opened state.

Optional parentAnnotation

parentAnnotation: AnnotationBase

Resolved reference to parent annotation.

Optional parentId

parentId: undefined | string

Parent annotation id for popup annotation.

popupId

popupId: string

Popup annotation id.

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.

Optional state

The State to which original annotation should be set.

Optional stateModel

The sateModel corresponding to State.