

Last date modified: July 02 2025
A collection of IViewerCardInstances
readonly
activeType:string
Current active viewer type
readonly
activeViewer:IViewerCardInstance
Current active viewer
readonly
bottomToolbar:IToolbar
The bottom toolbar for the viewer collection
readonly
card:ICard
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.
readonly
optional
codingCards:ICard
[]
Coding cards correlated to this viewer collection
readonly
contentHighlighting:IContentHighlightingManager
Content highlighting manager API for this viewer collection
This can be used to access the highlighting API and card API for specific content highlighting features.
readonly
contentType:ContentType
The type of content being displayed by the viewer collection
If not content has been loaded yet, this will be undefined
readonly
currentDocumentMetric:IPartialMetric
Current document metric
This can be used to enrich the monitoring data that is reported for the content view.
readonly
hasActiveViewer:boolean
true if there is currently an active viewer, false if not
readonly
id:string
ID
readonly
isBootstrapped:boolean
Whether viewer collection has been bootstrapped
readonly
isNavigating:boolean
Whether the viewer collection is navigating
readonly
leftToolbar:IToolbar
The left toolbar for the viewer collection
readonly
pageLayout:IViewerCollectionPageLayoutApi
API for synchronizing page layout mode across all of the collection's viewers
readonly
queuePointer:IQueuePointer
Queue pointer used for navigation
readonly
queuePointerStack:IQueuePointer
[]
Previously visited queues
readonly
rightToolbar:IToolbar
The right toolbar for the viewer collection
readonly
supportedViewerTypes:string
[]
ViewerTypes of the viewer collection's viewers
readonly
zoom:IViewerCollectionZoomApi
API for synchronizing zoom across all of the collection's viewers
getDockLocation(
edge
):ICardLocation
Retrieves the ICardLocation for the dock on the corresponding edge of the collection
• edge: RectangleEdge
Edge of the collection to retrieve the dock location for
Location data that can be used to place cards within the requested dock
getPublicDocumentData(
item
):Promise
<IPublicDocumentData
>
Get the public document information for a given queue item
• item: IQueueItem
IQueueItem to request information for
Promise
<IPublicDocumentData
>
The document data
getViewer(
type
):IViewerCardInstance
Retrieves the IViewerCardInstance with the provided type from the collection
• type: string
Viewer type to retrieve
The retrieved instance
getViewerCard(
type
):IViewerCard
Retreives the IViewerCard with the provided type from the collection
• type: string
Viewer type to retrieve
The retrieved viewer card
off(
eventType
,handler
?,once
?):void
Unregisters an event handler
• eventType: ViewerCollectionEventType
Event to unregister from
• handler?: EventHandler
Event handler function. If not passed in, it removes all event handlers.
• once?: boolean
Boolean indicating if the event handler was registered as a one-time event handler (Defaults to false)
void
on(
eventType
,handler
):void
Registers an event handler
• eventType: ViewerCollectionEventType
Event to listen for
• handler: EventHandler
Event handler function
void
once(
eventType
,handler
):void
Registers an event handler that is only run once
• eventType: ViewerCollectionEventType
Event to listen for
• handler: EventHandler
Event handler function
void
popQueuePointer(...
rest
):Promise
<boolean
>
Sets the current queue pointer to the last-saved queue pointer in the stack
• ...rest: any
[]
Promise
<boolean
>
Whether or not the queue was reverted
reload(
performanceWorkflow
?,reloadOptions
?, ...rest
?):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
• performanceWorkflow?: IPerformanceWorkflow
Optional workflow object to track metrics
• reloadOptions?: IReloadOptions
Optional reload options to occur on a reload action
• ...rest?: any
[]
Promise
<void
>
Promise that is resolved once the reload is complete
setQueuePointer(
newPointer
,savePointer
?, ...rest
?):Promise
<void
>
Sets IQueuePointer used for navigation The viewer collection will update to reflect the index and viewer type of the new pointer
• newPointer: IQueuePointer
New queue pointer to use for navigation
• savePointer?: boolean
Determines whether the current active pointer is stored in queue navigation history. Defaults true.
• ...rest?: any
[]
Promise
<void
>
Promise that resolves when the viewer collection has been updated
switchToQueuePointerById(
id
, ...rest
):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
• id: string
The Guid identifier of the pointer to set
• ...rest: any
[]
Promise
<boolean
>
Whether or not the queue was reverted
switchToQueuePointerByIndex(
index
, ...rest
):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
• index: number
The index of the pointer to navigate to
• ...rest: any
[]
Promise
<boolean
>
Whether or not the queue was reverted
On this page
Why was this not helpful?
Check one that applies.
Thank you for your feedback.
Want to tell us more?
Great!
Additional Resources |
|||
DevHelp Community | GitHub | Release Notes | NuGet |