Options
All
  • Public
  • Public/Protected
  • All
Menu

A class representing an Annotation

Hierarchy

  • BoundEntity<Annotation, AnnotationEntity, { markedAsRead: any }>
    • Annotation

Index

Properties

id: string
xfdf: string
annotationId: string
author: User
documentId: string
isRead: boolean
__type: keyof EntityStateMetadata
contents?: string
inReplyTo?: string
mentions?: Mention[]
document?: Document
createdAt?: Date
updatedAt?: Date

Accessors

  • get hasMention(): boolean
  • Returns boolean

Methods

  • draw(): Promise<void>
  • Draws the annotation in the UI

    Returns Promise<void>

  • select(): void
  • Selects the annotation in the UI

    Returns void

  • Gets a list of all User mentions Returns an array of Mention classes

    Returns Promise<Mention[]>

  • markAsRead(): Promise<void>
  • Marks the annotation as read

    Returns Promise<void>

  • Fired when this annotation is marked as read

    Parameters

    Returns UnsubscribeFunction

    Returns a function that can be called to unsubscribe from the event

  • Fired when anything about this annotation changes

    Parameters

    Returns UnsubscribeFunction

    Returns a function that can be called to unsubscribe from the event

  • Fired when this annotation is deleted from the document

    Parameters

    • event: "onDestroy"
    • listener: (id: string) => void
        • (id: string): void
        • Parameters

          • id: string

          Returns void

    Returns UnsubscribeFunction

    Returns a function that can be called to unsubscribe from the event

Generated using TypeDoc