DsPdfJS API v9.1.0

DsPdfJS API / MarkupAnnotationProperties

Type Alias: MarkupAnnotationProperties

MarkupAnnotationProperties = AnnotationBaseProperties & object

The common properties for markup annotations that are used primarily to mark up PDF documents.

Type Declaration

color?

optional color: Color

The annotation color, it used as color of popup window, lines color etc.

creationDate?

optional creationDate: PdfDateTime

The date and time when the annotation was created.

opacity?

optional opacity: number

The opacity value to be used in painting the annotation. This value applies to all visible elements of the annotation in its closed state (including its background and border) but not to the pop-up window that appears when the annotation is opened. Not specified means 1 (means 100% opacity)

popup?

optional popup: PopupAnnotation | PopupAnnotationProperties

The PopupAnnotation or PopupAnnotationProperties object for entering or editing text associated with this annotation. Setting this property changes the PopupAnnotation#parent property. A separate PopupAnnotation allows defining additional properties of the popup window: color, position etc.

reference?

optional reference: object

The annotation referenced by this annotation.

reference.target

target: MarkupAnnotation

The annotation referenced by this annotation.

reference.type?

optional type: AnnotationReferenceType

The relationship (reference type) between this annotation and the annotation specified by the 'target' property. The referenced annotation should be on the same page with the current annotation. Not specified means "Reply".

richText?

optional richText: string

The text to be displayed in the pop-up window when the annotation is opened. This text can be formatted using HTML tags, see PDF specification for details.

subject?

optional subject: string

The text representing a short description of the subject being addressed by the annotation.

userName?

optional userName: string

The text label to be displayed in the title bar of the annotation's pop-up window when open and active. By convention, this entry identifies the user who added the annotation.

See

MarkupAnnotation