Interface ILineAnnotation

A straight line or arrow drawn on a page.

interface ILineAnnotation {
    accessType?: LfRepositoryClientV2.AnnotationAccessControlType;
    beginPosition?: LfRepositoryClientV2.AnnotationPoint;
    beginStyle?: LfRepositoryClientV2.LineEndingStyle;
    color?: string;
    comment?: string;
    createdTime?: Date;
    creator?: string;
    customData?: string;
    endColor?: string;
    endPosition?: LfRepositoryClientV2.AnnotationPoint;
    endStyle?: LfRepositoryClientV2.LineEndingStyle;
    entryId?: number;
    isProtected?: boolean;
    isReadOnly?: boolean;
    itemId?: number;
    lastModifiedTime?: Date;
    lineStyle?: LfRepositoryClientV2.LineStyle;
    opacity?: number;
    pageNumber?: number;
    reasonId?: number;
    thickness?: number;
    visibility?: LfRepositoryClientV2.AnnotationVisibility;
    zOrder?: number;
}

Hierarchy (View Summary)

Implemented by

Properties

accessType? beginPosition? beginStyle? color? comment? createdTime? creator? customData? endColor? endPosition? endStyle? entryId? isProtected? isReadOnly? itemId? lastModifiedTime? lineStyle? opacity? pageNumber? reasonId? thickness? visibility? zOrder?

Properties

OptionalaccessType

accessType?: LfRepositoryClientV2.AnnotationAccessControlType

How the annotation participates in access control.

OptionalbeginPosition

beginPosition?: LfRepositoryClientV2.AnnotationPoint

The start point of the line.

OptionalbeginStyle

beginStyle?: LfRepositoryClientV2.LineEndingStyle

The cap style at the start of the line.

Optionalcolor

color?: string

The line 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.

OptionalendColor

endColor?: string

The end-cap color as an RGB hex string; null if transparent.

OptionalendPosition

endPosition?: LfRepositoryClientV2.AnnotationPoint

The end point of the line.

OptionalendStyle

endStyle?: LfRepositoryClientV2.LineEndingStyle

The cap style at the end of the line.

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 line stroke style.

Optionalopacity

opacity?: number

The opacity of the line 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.

Optionalthickness

thickness?: number

The line 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.

Settings

Member Visibility

On This Page

Properties