Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PopupAnnotation

A popup annotation (PDF 1.3) displays text in a popup window for entry and editing. It shall not appear alone but is associated with a markup annotation, its parent annotation, and shall be used for editing the parent’s text. It shall have no appearance stream or associated actions of its own and shall be identified by the Popup entry in the parent’s annotation dictionary

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.

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.

Optional parentAnnotation

parentAnnotation: AnnotationBase

Resolved reference to parent annotation.

Optional parentId

parentId: undefined | string

Parent annotation id for popup annotation.

Optional popupId

popupId: undefined | string

Popup id if any.

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

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.

Optional stateModel

The state model corresponding to state.