A text box with a pointer leading to a focus point on the page.

Hierarchy (View Summary)

Implements

Constructors

Properties

_discriminator: string

How the annotation participates in access control.

borderColor?: string

The border and pointer color as an RGB hex string; null if transparent.

borderStyle?: LineStyle

The border stroke style.

borderThickness?: number

The border thickness in pixels.

boxCoordinates?: AnnotationRectangle

The bounding rectangle of the callout's text box.

comment?: string

An optional comment on the annotation.

createdTime?: Date

The UTC time the annotation was created.

creator?: string

The security identifier (SID) of the user that created the annotation.

customData?: string

Optional application-defined custom data stored with the annotation.

direction?: TextDirection

The reading direction of the text.

entryId?: number

The ID of the document entry the annotation belongs to.

fillColor?: string

The fill color as an RGB hex string; null if not filled.

focusPosition?: AnnotationPoint

The point the callout pointer leads to.

focusStyle?: LineEndingStyle

The cap style at the focus end of the pointer.

isProtected?: boolean

A boolean indicating whether the annotation is protected so that only its creator can modify it.

isReadOnly?: boolean

A boolean indicating whether the annotation is read-only (for example, on an archived version).

itemId?: number

The identifier of the annotation, unique within its page.

lastModifiedTime?: Date

The UTC time the annotation was last modified.

opacity?: number

The opacity of the callout as a percentage (0-100).

pageNumber?: number

The 1-based page number the annotation is on.

reasonId?: number

The ID of the redaction reason associated with the annotation, if any.

text?: string

The text displayed in the callout.

textSize?: number

The font size of the text in points.

Controls who can see the annotation.

zOrder?: number

The z-order of the annotation; higher values draw on top.

Methods