Interface IFreeHandAnnotation

A freehand-drawn multi-point line on a page.

interface IFreeHandAnnotation {
    accessType?: AnnotationAccessControlType;
    color?: string;
    comment?: string;
    createdTime?: Date;
    creator?: string;
    customData?: string;
    entryId?: number;
    isProtected?: boolean;
    isReadOnly?: boolean;
    itemId?: number;
    lastModifiedTime?: Date;
    lineStyle?: LineStyle;
    opacity?: number;
    pageNumber?: number;
    points?: AnnotationPoint[];
    reasonId?: number;
    thickness?: number;
    visibility?: AnnotationVisibility;
    zOrder?: number;
}

Hierarchy (View Summary)

Implemented by

Properties

accessType? color? comment? createdTime? creator? customData? entryId? isProtected? isReadOnly? itemId? lastModifiedTime? lineStyle? opacity? pageNumber? points? reasonId? thickness? visibility? zOrder?

Properties

OptionalaccessType

accessType?: AnnotationAccessControlType

How the annotation participates in access control.

Optionalcolor

color?: string

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

Optionalcomment

comment?: string

An optional comment on the annotation.

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.

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.

OptionallineStyle

lineStyle?: LineStyle

The stroke style.

Optionalopacity

opacity?: number

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

OptionalpageNumber

pageNumber?: number

The 1-based page number the annotation is on.

Optionalpoints

points?: AnnotationPoint[]

The ordered points of the freehand stroke.

OptionalreasonId

reasonId?: number

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

Optionalthickness

thickness?: number

The stroke thickness in pixels.

Optionalvisibility

visibility?: AnnotationVisibility

Controls who can see the annotation.

OptionalzOrder

zOrder?: number

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

Settings

Member Visibility

On This Page

Properties