Class RectangleAnnotation

A rectangle, rounded rectangle, or ellipse drawn on a page.

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

_discriminator accessType? borderColor? borderStyle? borderThickness? boxStyle? comment? coordinates? createdTime? creator? customData? entryId? fillColor? isProtected? isReadOnly? itemId? lastModifiedTime? opacity? pageNumber? reasonId? visibility? zOrder?

Methods

init toJSON fromJS

Constructors

constructor

Properties

Protected_discriminator

_discriminator: string

OptionalaccessType

accessType?: AnnotationAccessControlType

How the annotation participates in access control.

OptionalborderColor

borderColor?: string

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

OptionalborderStyle

borderStyle?: LineStyle

The border stroke style.

OptionalborderThickness

borderThickness?: number

The border thickness in pixels.

OptionalboxStyle

boxStyle?: BoxStyle

The shape drawn within the bounding rectangle.

Optionalcomment

comment?: string

An optional comment on the annotation.

Optionalcoordinates

coordinates?: AnnotationRectangle

The bounding rectangle of the shape.

OptionalcreatedTime

createdTime?: Date

The UTC time the annotation was created.

Optionalcreator

creator?: string

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

OptionalcustomData

customData?: string

Optional application-defined custom data stored with the annotation.

OptionalentryId

entryId?: number

The ID of the document entry the annotation belongs to.

OptionalfillColor

fillColor?: string

The fill color as an RGB hex string (for example, "#FF0000"); null if not filled.

OptionalisProtected

isProtected?: boolean

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

OptionalisReadOnly

isReadOnly?: boolean

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

OptionalitemId

itemId?: number

The identifier of the annotation, unique within its page.

OptionallastModifiedTime

lastModifiedTime?: Date

The UTC time the annotation was last modified.

Optionalopacity

opacity?: number

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

OptionalpageNumber

pageNumber?: number

The 1-based page number the annotation is on.

OptionalreasonId

reasonId?: number

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

Optionalvisibility

visibility?: AnnotationVisibility

Controls who can see the annotation.

OptionalzOrder

zOrder?: number

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

Methods

init

toJSON

StaticfromJS

Settings

Member Visibility

On This Page

Constructors
Properties
Methods