Interface IViewerService

Entity for managing IViewerCollections

Hierarchy

IEventEmitter<ViewerServiceEventType>
- IViewerService

Index

Properties

Methods

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

get

get(id: string): IViewerCollection

Retrieves a viewer collection by ID

Parameters
- id: string
  
  Collection ID
Returns IViewerCollection

Viewer collection with the given ID

off

off(eventType: ViewerServiceEventType, handler?: EventHandler, once?: boolean): void

Inherited from IEventEmitter.off
Unregisters an event handler

Parameters
- eventType: ViewerServiceEventType
  
  Event to unregister from
- Optional handler: EventHandler
  
  Event handler function. If not passed in, it removes all event handlers.
- Optional once: boolean
  
  Boolean indicating if the event handler was registered as a one-time event handler (Defaults to false)
Returns void

on

on(eventType: ViewerServiceEventType, handler: EventHandler): void

Inherited from IEventEmitter.on
Registers an event handler

Parameters
- eventType: ViewerServiceEventType
  
  Event to listen for
- handler: EventHandler
  
  Event handler function
Returns void

once

once(eventType: ViewerServiceEventType, handler: EventHandler): void

Inherited from IEventEmitter.once
Registers an event handler that is only run once

Parameters
- eventType: ViewerServiceEventType
  
  Event to listen for
- handler: EventHandler
  
  Event handler function
Returns void

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

Send comments on this topic to Relativity documentation