Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IViewerCollection

A collection of IViewerCardInstances

Hierarchy

Index

Properties

activeType

activeType: ViewerType | undefined

Current active viewer type

activeViewer

activeViewer: IViewerCardInstance | undefined

Current active viewer

bottomToolbar

bottomToolbar: IToolbar

The bottom toolbar for the viewer collection

card

card: ICard | undefined

Gets the card associated with this viewer collection

The card will not be defined until the viewer collection has been bootstrapped and will be set to undefined once it has been torn down.

Optional codingCards

codingCards: ICard[]

Coding cards correlated to this viewer collection

contentType

contentType: ContentType | undefined

The type of content being displayed by the viewer collection

If not content has been loaded yet, this will be undefined

hasActiveViewer

hasActiveViewer: boolean

true if there is currently an active viewer, false if not

id

id: string

ID

isBootstrapped

isBootstrapped: boolean

Whether viewer collection has been bootstrapped

isNavigating

isNavigating: boolean

Whether the viewer collection is navigating

leftToolbar

leftToolbar: IToolbar

The left toolbar for the viewer collection

pageLayout

API for synchronizing page layout mode across all of the collection's viewers

queuePointer

queuePointer: IQueuePointer

Queue pointer used for navigation

queuePointerStack

queuePointerStack: IQueuePointer[]

Previously visited queues

rightToolbar

rightToolbar: IToolbar

The right toolbar for the viewer collection

supportedViewerTypes

supportedViewerTypes: ViewerType[]

ViewerTypes of the viewer collection's viewers

zoom

API for synchronizing zoom across all of the collection's viewers

Methods

getDockLocation

  • Retrieves the ICardLocation for the dock on the corresponding edge of the collection

    Parameters

    • edge: RectangleEdge

      Edge of the collection to retrieve the dock location for

    Returns ICardLocation | undefined

    Location data that can be used to place cards within the requested dock

getPublicDocumentData

  • Get the public document information for a given queue item

    Parameters

    • item: IQueueItem

      IQueueItem to request information for

    Returns Promise<IPublicDocumentData>

    The document data

getViewer

getViewerCard

  • Retreives the IViewerCard with the provided type from the collection

    Parameters

    Returns IViewerCard | undefined

    The retrieved viewer card

off

  • Unregisters an event handler

    Parameters

    • eventType: ViewerCollectionEventType

      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

once

popQueuePointer

  • popQueuePointer(...rest: any[]): Promise<boolean>
  • Sets the current queue pointer to the last-saved queue pointer in the stack

    Parameters

    • Rest ...rest: any[]

    Returns Promise<boolean>

    Whether or not the queue was reverted

reload

  • reload(...rest: any[]): Promise<void>
  • Reload lifecycle method that is invoked when the viewer instance should refresh all of it's data before reloading the current queue item

    Parameters

    • Rest ...rest: any[]

    Returns Promise<void>

    Promise that is resolved once the reload is complete

setQueuePointer

  • setQueuePointer(newPointer: IQueuePointer, savePointer?: boolean, ...rest: any[]): Promise<void>
  • Sets IQueuePointer 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

    • Optional savePointer: boolean

      Determines whether the current active pointer is stored in queue navigation history. Defaults true.

    • Rest ...rest: any[]

    Returns Promise<void>

    Promise that resolves when the viewer collection has been updated

switchToQueuePointerById

  • switchToQueuePointerById(id: string, ...rest: any[]): Promise<boolean>
  • Sets the current queue pointer to that in the queue pointer stack with the provided id All subsequent pointers in the stack are destroyed

    Parameters

    • id: string

      The Guid identifier of the pointer to set

    • Rest ...rest: any[]

    Returns Promise<boolean>

    Whether or not the queue was reverted

switchToQueuePointerByIndex

  • switchToQueuePointerByIndex(index: number, ...rest: any[]): Promise<boolean>
  • Sets the current queue pointer to that located at the provided index in the queue pointer stack All subsequent pointers in the stack are destroyed

    Parameters

    • index: number

      The index of the pointer to navigate to

    • Rest ...rest: any[]

    Returns Promise<boolean>

    Whether or not the queue was reverted