Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IContextMenuReviewData

Information provided to IContextMenuItems about the document being interacted with

Hierarchy

  • IContextMenuReviewData

Index

Properties

Methods

Properties

cursor

cursor: Cursor

Location of the right click event on the document

queuePointer

queuePointer: IQueuePointer

IQueuePointer of the current item being viewed in the {@link IViewerService.queuePointer}

workspaceId

workspaceId: number

Workspace artifact ID

Methods

exists

  • exists(keyName: string): boolean

  • Gets whether the key/value pair exists on review data

    Parameters

    • keyName: string

      The name of the key

    Returns boolean

    Returns a boolean whether the pair exists

get

  • get(keyName: string): any

  • Gets the value for a key in the review data

    Parameters

    • keyName: string

      The name of the key

    Returns any

    Returns the object that was saved.

getAnnotationsAtCursor

getSelectedAnnotations

  • Retrieves all IAnnotations currently selected

    The topmost IAnnotation at the cursor position will be included with this list, even if it is not selected.

    Returns IAnnotation[]

getSelectedText

  • getSelectedText(): string

  • Retrieves the text that is currently selected

    Returns string

    Returns the selected text from the viewer

set

  • set(keyName: string, value: any): void

  • Sets a key/value pair in review data

    Parameters

    • keyName: string

      The name of the key

    • value: any

      The value of the key

    Returns void