Annotations

Annotation

Detailed reference for Annotation.

Base annotation model used by API methods that work across multiple annotation kinds.

Type details

  • Kind: class
  • Declared members: 35

Declaration

class Annotation {
  readonly type: AnnotationType;
  readonly id: string;
  readonly pageIndex: number;
  readonly boundingBox: Rect;
  readonly opacity: number;
  readonly color: Color | null;
  readonly strokeColor: Color | null;
  readonly creatorName: string | null;
  readonly createdAt: Date;
  readonly updatedAt: Date | null;
  readonly customData: Record<string, unknown> | null;
  readonly subject: string | null;
  readonly name: string | null;
  readonly note: string | null;
  readonly hidden: boolean;
  readonly noView: boolean;
  readonly noPrint: boolean;
  readonly noRotate: boolean;
  readonly noZoom: boolean;
  readonly readOnly: boolean;
  readonly locked: boolean;
  readonly lockedContents: boolean;
  readonly group: string | null;
  readonly action: AnnotationData['action'] | null;
  // ...
}

Members

  • type
  • id
  • pageIndex
  • boundingBox
  • opacity
  • color
  • strokeColor
  • creatorName
  • createdAt
  • updatedAt
  • customData
  • subject
  • name
  • note
  • hidden
  • noView
  • noPrint
  • noRotate
  • noZoom
  • readOnly
  • locked
  • lockedContents
  • group
  • action