Interface IViewerCollection

A collection of IViewerInstances

Hierarchy

IEventEmitter<ViewerCollectionEventType>
- IViewerCollection

Index

Properties

Methods

Properties

activeViewer

activeViewer: IViewerInstance

Current active viewer

id

id: string

ID

isBootstrapped

isBootstrapped: boolean

Whether viewer collection has been bootstrapped

menu

menu: IViewerMenu

API for managing the collection's viewer menu

queuePointer

queuePointer: IQueuePointer

Queue pointer used for navigation

Methods

getViewer

getViewer(type: ViewerType): IViewerInstance

Retrieves the IViewerInstance with the provided type from the collection

Parameters
- type: ViewerType
  
  Viewer type to retrieve
Returns IViewerInstance

The retrieved instance

off

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

Inherited from IEventEmitter.off
Unregisters an event handler

Parameters
- eventType: ViewerCollectionEventType
  
  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

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

Inherited from IEventEmitter.on
Registers an event handler

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

once

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

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

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

setQueuePointer

setQueuePointer(newPointer: IQueuePointer): Promise<void>

Sets the queue pointer used for navigation

The viewer collection will update to reflect the index and viewer type of the new pointer

Parameters
- newPointer: IQueuePointer
  
  New queue pointer to use for navigation
Returns Promise<void>

Promise that resolves when the viewer collection has been updated

Send comments on this topic to Relativity documentation