Class FreeHandAnnotation

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

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

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

Methods

init toJSON fromJS

Constructors

constructor

Properties

Protected_discriminator

_discriminator: string

OptionalaccessType

accessType?: LfRepositoryClientV2.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?: LfRepositoryClientV2.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?: LfRepositoryClientV2.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?: LfRepositoryClientV2.AnnotationVisibility

Controls who can see the annotation.

OptionalzOrder

zOrder?: number

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

Methods

init

  • init(_data?: any): void

    Parameters

    • Optional_data: any

    Returns void

toJSON

  • toJSON(data?: any): any

    Parameters

    • Optionaldata: any

    Returns any

StaticfromJS

Settings

Member Visibility

On This Page

Constructors
Properties
Methods