Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IViewerService

Entity for managing IViewerCollections

Hierarchy

Index

Properties

count

count: number

Number of existing IViewerCollections

mainCollection

mainCollection: IViewerCollection

The main viewer collection

This is the viewer collection that occupies the main slot in the UI. When the Review Interface is bootstrapped, this is the first collection created.

Methods

createCollection

  • Creates a new viewer collection

    Parameters

    • pointer: IQueuePointer

      Queue pointer

    • Optional types: ViewerType[]

    Returns IViewerCollection

    Newly created collection

get

  • Retrieves a viewer collection by ID

    Parameters

    • id: string

      Collection ID

    Returns IViewerCollection

    Viewer collection with the given ID

off

  • Unregisters an event handler

    Parameters

    • eventType: ViewerServiceEventType

      Event to unregister from

    • handler: EventHandler

      Event handler function

    • Optional once: boolean

      Boolean indicating if the event handler was registered as a one-time event handler (Defaults to false)

    Returns void

on

once

remove

  • remove(id: string): boolean
  • Removes a viewer collection

    Parameters

    • id: string

      Collection ID

    Returns boolean

    Boolean indicating whether or not the collection was removed