DsPdfJS API v9.1.0

DsPdfJS API / TextAnnotationProperties

Type Alias: TextAnnotationProperties

TextAnnotationProperties = MarkupAnnotationProperties & object

Defines properties of a sticky note attached to a point in a PDF document.

Type Declaration

icon?

optional icon: TextAnnotationIcon

The type of the icon used to display the annotation, possible values: "Note", "Comment", "Key", "Help", "NewParagraph", "Paragraph", "Insert".

open?

optional open: boolean

A flag specifying whether the annotation should initially be displayed open.

state?

optional state: string

The state to which the original annotation shall be set. The following describes the predefined combinations of State and StateModel, and their meanings:

1. StateModel "Marked", State "Marked" The annotation has been marked by the user.
2. StateModel "Marked", State "Unmarked" The annotation has not been marked by the user (the default).
3. StateModel "Review", State "Accepted" The user agrees with the change.
4. StateModel "Review", State "Rejected" The user disagrees with the change.
5. StateModel "Review", State "Cancelled" The change has been cancelled.
6. StateModel "Review", State "Completed" The change has been completed.
7. StateModel "Review", State "None" The user has indicated nothing about the change (the default).

See PDF specification for more details.

stateModel?

optional stateModel: string

The state model corresponding to 'State'.

See 'State' and PDF specification for details.

type

type: "text"

See

TextAnnotation