Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAnnotationsService

Class for working with IAnnotations and IMarkupSets

Hierarchy

  • IAnnotationsService

Index

Methods

Methods

getAnnotationHistory

  • getAnnotationHistory(workspaceId: number, documentId: number, annotationId: number, markupSetId: number, clientId: string): Promise<IAnnotationHistoryData[]>

  • Retrieves the IAnnotationHistoryData for the selected annotation.

    Parameters

    • workspaceId: number

      Current Workspace ID

    • documentId: number

      Current Document ID

    • annotationId: number

      Selected Annotation ID

    • markupSetId: number

      Active Markup Set ID

    • clientId: string

      Client ID

    Returns Promise<IAnnotationHistoryData[]>

getAnnotationVisibility

getAnnotationVisibilityFromSession

getDefaultMarkupSetData

  • Retrieves the default IMarkupSet the user has access to based on the Order field

    Returns Promise<IMarkupSet>

    Promise that resolves to the default markup set

getMarkupSetAnnotations

getMarkupSetData

  • getMarkupSetData(refreshCache?: boolean): Promise<IMarkupSet[]>

  • Retrieves the available IMarkupSets the user has access to in the workspace

    Parameters

    • Optional refreshCache: boolean

    Returns Promise<IMarkupSet[]>

    Promise that resolves to an array of markup sets

getUserDefaultRedactionText

  • getUserDefaultRedactionText(): Promise<string>

  • Retrieves the default redaction text for the user

    Returns Promise<string>

    Promise that resolves to the default redaction text

getUserDefaultRedactionTextSize

persistNewMarkupSetSelection

  • persistNewMarkupSetSelection(markupSetArtifactId: number): void

  • Saves the specified markup set Artifact ID to the User Preferences cache and table as the user's default.

    Parameters

    • markupSetArtifactId: number

      Artifact ID of the markup set to persist.

    Returns void

setAnnotationVisibility

  • Sets the annotation visibility in sessionStorage and locally

    Parameters

    Returns void

setUserDefaultRedactionText

  • setUserDefaultRedactionText(text: string): void

  • Updates the user's default redaction text

    description

    This will make a "fire-and-forget" call to persist the user's default redaction text to the database

    Parameters

    • text: string

      New default redaction text

    Returns void

setUserDefaultRedactionTextSize