Feedback
Last date modified: 2025-Oct-28
Interface: IProductionViewer
Production Viewer IViewerCardInstance
Extends
Properties
cardActivated()?
optionalcardActivated: (api,card) =>void
Called after the card is activated in a dock.
Parameters
• api: IReviewInterfaceApi
• card: ICard
Returns
void
Inherited from
IOutsideInViewer.cardActivated
cardBuildTabOptions()?
optionalcardBuildTabOptions: (api,card,item,productionArtifactId?,longTextFieldArtifactId?,productionType?) =>IViewerCardTabOption[] |Promise<IViewerCardTabOption[]>
If provided, this function will be called to build custom viewer tab options for the viewer card.
If no function is provided, a default tab will be created based on the card title.
Parameters
• api: IReviewInterfaceApi
• card: IViewerCard
• item: IQueueItem
• productionArtifactId?: number
• longTextFieldArtifactId?: number
• productionType?: ProductionType
Returns
IViewerCardTabOption[] | Promise<IViewerCardTabOption[]>
Inherited from
IOutsideInViewer.cardBuildTabOptions
cardBuildToolbarOptions()?
optionalcardBuildToolbarOptions: (api,card,viewerToolbar) =>void|Promise<void>
If provided, this function will be called to build custom viewer toolbar options for the viewer card.
Parameters
• api: IReviewInterfaceApi
• card: IViewerCard
• viewerToolbar: IToolbar
Returns
void | Promise<void>
Inherited from
IOutsideInViewer.cardBuildToolbarOptions
cardCanDeactivate()?
optionalcardCanDeactivate: (api,card) =>boolean
Called before the card deactivates to check if it is safe to do so
Parameters
• api: IReviewInterfaceApi
• card: ICard
Returns
boolean
Inherited from
IOutsideInViewer.cardCanDeactivate
cardCreateUnsupportedOverlayCard()?
optionalcardCreateUnsupportedOverlayCard: (api,card,item) =>Promise<ICard>
Called when the viewer collection needs a card to show when the viewer does not support the item. A default placeholder is shown if this method is not provided.
Parameters
• api: IReviewInterfaceApi
• card: IViewerCard
• item: IQueueItem
Returns
Promise<ICard>
Inherited from
IOutsideInViewer.cardCreateUnsupportedOverlayCard
cardDeactivated()?
optionalcardDeactivated: (api,card) =>void
Called after the card is deactivated in a dock.
Parameters
• api: IReviewInterfaceApi
• card: ICard
Returns
void
Inherited from
IOutsideInViewer.cardDeactivated
cardError()?
optionalcardError: (api,card,err) =>void
Called whenever an error occurs while managing the card
Parameters
• api: IReviewInterfaceApi
• card: ICard
• err: Error
Returns
void
Inherited from
cardLoaded()?
optionalcardLoaded: (api,card,target) =>void|Promise<void>
Called after the card content has loaded
Parameters
• api: IReviewInterfaceApi
• card: ICard
• target: HTMLElement
Returns
void | Promise<void>
Inherited from
cardLoadState()?
optionalcardLoadState: (api,card,saveData) =>void
Called to restore the state of the card
Parameters
• api: IReviewInterfaceApi
• card: ICard
• saveData: ICardCustomState
Returns
void
Inherited from
IOutsideInViewer.cardLoadState
cardMaximized()?
optionalcardMaximized: (api,card) =>void
Called when the card is maximized
Parameters
• api: IReviewInterfaceApi
• card: ICard
Returns
void
Inherited from
IOutsideInViewer.cardMaximized
cardResized()?
optionalcardResized: (api,card) =>void
Called when the card is resized
Parameters
• api: IReviewInterfaceApi
• card: ICard
Returns
void
Inherited from
cardRestored()?
optionalcardRestored: (api,card) =>void
Called when the card is no longer maximized
Parameters
• api: IReviewInterfaceApi
• card: ICard
Returns
void
Inherited from
cardSaveState()?
optionalcardSaveState: (api,card) =>ICardCustomState
Called to save the state of the card
Parameters
• api: IReviewInterfaceApi
• card: ICard
Returns
Inherited from
IOutsideInViewer.cardSaveState
cardUnloaded()?
optionalcardUnloaded: (api,card) =>void|Promise<void>
Called before the card content is unloaded
Parameters
• api: IReviewInterfaceApi
• card: ICard
Returns
void | Promise<void>
Inherited from
contextualSearchView
readonlycontextualSearchView:BasicView
Contextual Search View
Inherited from
IOutsideInViewer.contextualSearchView
currentPageIndex
currentPageIndex:
number
Gets the current page index.
Inherited from
IOutsideInViewer.currentPageIndex
currentPageName
currentPageName:
string
Gets the current page name
Inherited from
IOutsideInViewer.currentPageName
designationRendering
readonlydesignationRendering:DesignationRendering
The current designation rendering for the viewer or undefined if none is set
Inherited from
IOutsideInViewer.designationRendering
hasWaveform
readonlyhasWaveform:boolean
Checks if the current native supports the waveform view
Inherited from
highlights
readonlyhighlights:IViewerHighlightManager
Gets the Persistent Highlights Manager object
Inherited from
id
readonlyid:string
Unique viewer instance ID
Inherited from
loadError
readonlyloadError:Error
Populated with error when loadSuccessful is false. Otherwise, undefined.
Inherited from
loadSuccessful
readonlyloadSuccessful:boolean
Returns true, if document was loaded into view without error.
Inherited from
IOutsideInViewer.loadSuccessful
oiPagesLoadedCount
oiPagesLoadedCount:
number
Gets the current number of loaded pages for the current document.
Inherited from
IOutsideInViewer.oiPagesLoadedCount
shouldHighlight
readonlyshouldHighlight:boolean
Whether highlights should be applied to the currently loaded document
Inherited from
IHighlightViewer.shouldHighlight
showWaveformView
showWaveformView:
boolean
Gets or sets the waveform viewer for multimedia
Inherited from
IOutsideInViewer.showWaveformView
thumbnailView
readonlythumbnailView:BasicView
The Thumbnail viewer for the view
Inherited from
IOutsideInViewer.thumbnailView
timelineView
readonlytimelineView:BasicView
The Timeline viewer for the view
Inherited from
transcriptDesignationRendering
readonlytranscriptDesignationRendering:DesignationRendering
The current designation rendering for the associated transcript (if there is one) or undefined if none is set
If there is no associated transcript or if it has not yet been initialized, this will return undefined.
Inherited from
IOutsideInViewer.transcriptDesignationRendering
transcriptView
readonlytranscriptView:View
The Transcript viewer for the view
Inherited from
IOutsideInViewer.transcriptView
transientHighlight
readonlytransientHighlight:ITransientHighlightManager
The Transient Highlight Manager for the view
Inherited from
IOutsideInViewer.transientHighlight
type
readonlytype:string
Viewer type - this should match the viewer type from the configuration object
Inherited from
unsupportedTabTitle?
readonlyoptionalunsupportedTabTitle:string
If provided, this defines the viewer's tab title when the viewer does not support the current queue item.
If not provided, the title will default to "No " in this scenario.
Inherited from
IOutsideInViewer.unsupportedTabTitle
Methods
cardLoadItem()
cardLoadItem(
item,options, ...rest):Promise<boolean>
Called when the viewer card should load a new queue item
Parameters
• item: IQueueItem
Queue item to be loaded
• options: ILoadOptions
Load options
• ...rest: any[]
Returns
Promise<boolean>
Promise that resolves to a boolean indicating whether or not the load was successful
Inherited from
checkHasFeature()
checkHasFeature(
feature):boolean
Checks the OI Aqua API to see whether the viewer's current state can support the specified feature
Parameters
• feature: ViewFeature
The ViewFeature (enum) being checked
Returns
boolean
Whether or not the viewer can support the specified feature
Inherited from
IOutsideInViewer.checkHasFeature
createCellRange()
createCellRange(
sheet,c1,r1,c2?,r2?):CellRangeMemento
Creates a CellRangeMemento representing the cell or range of cells at the specified spreadsheet or database table, row(s), and column(s). * *
Parameters
• sheet: number
The 0-based index of the page containing the range *
• c1: number
The 0-based index of the leftmost column of the range *
• r1: number
The 0-based index of the topmost row of the range *
• c2?: number
The 0-based index of the rightmost column of the range *
• r2?: number
The 0-based index of the bottommost row of the range *
Returns
CellRangeMoment object built with the provided arguments
Inherited from
IOutsideInViewer.createCellRange
createRectRange()
createRectRange(
sheet,left,top,right?,bottom?,units?,hdpi?,vdpi?):RectRangeMemento
Creates a RectRangeMemento representing a rectangle on the specified page
Parameters
• sheet: number
The 0-based index of the page containing the range
• left: number
The left edge of the rectangular range
• top: number
The top edge of the rectangular range
• right?: number
The right edge of the rectangular range
• bottom?: number
The bottom edge of the rectangular range
• units?: string
The units for left, top, right and bottom
• hdpi?: number
For "px" units, the horizontal DPI for the page containing the range
• vdpi?: number
For "px" units, the vertical DPI for the page containing the range
Returns
RectRangeMoment object built with the provided arguments
Inherited from
IOutsideInViewer.createRectRange
createTextRange()
createTextRange(
acc,accend):TextRangeMemento
Creates a TextRangeMemento corresponding to the specified ACC (actual character count) range
Parameters
• acc: number
The first character of the ACC range (inclusive)
• accend: number
The last character of the ACC range (non-inclusive)
Returns
Inherited from
IOutsideInViewer.createTextRange
getAquaView()
getAquaView(
type):Promise<View>
Internal
INTERNAL ONLY: Method for getting the aqua view based on the specified type If you call this on a viewer that will never have a transcript file(e.g. image viewer), or if the viewer hasn't loaded a document type that supports a transcript(i.e. an av or mdb file), the returned promise will never resolve.
Parameters
• type: AquaViewType
The type of view to get
Returns
Promise<View>
Inherited from
getExternalContent()
getExternalContent(
edge):HTMLElement
Returns the element that represents the external content previously set on the requested edge (top/left/right/bottom) for this view.
Parameters
• edge: ToolbarLocation
The edge (top/left/right/bottom) for which to get content.
Returns
HTMLElement
The requested external content, or null if none has been set.
Inherited from
IOutsideInViewer.getExternalContent
getFeatureManager()
getFeatureManager<
T>(featureName):T
Gets a feature manager instance for the specified feature
Type Parameters
• TextendsIViewerFeatureManager
Parameters
• featureName: "transcript"
The name of the feature
Returns
T
The feature manager instance or undefined if not found
Inherited from
IOutsideInViewer.getFeatureManager
getHiddenContentStatus()
getHiddenContentStatus():
HiddenContentType
Returns Outside In Show/Hide hidden Items status
Returns
The status of hidden content shown in the viewer (On or Off)
Inherited from
IOutsideInViewer.getHiddenContentStatus
getObjectsAtPosition()
getObjectsAtPosition(
x,y):IViewerObjects
Retrieves viewer objects at the specified position, including:
- Designations
- Highlights
- Hyperlinks
- Current viewer content selection
NOTE: This method will return undefined when no objects are present at the specified position
Parameters
• x: number
X coordinate of the position
• y: number
Y coordinate of the position
Returns
Object containing the viewer objects at the specified position
Inherited from
IOutsideInViewer.getObjectsAtPosition
getObjectsAtTranscriptPosition()
getObjectsAtTranscriptPosition(
x,y):IViewerObjects
Retrieves viewer objects at the specified position in the transcript view, including:
- Designations
- Highlights
- Hyperlinks
- Current viewer content selection
NOTE: This method will return undefined when no objects are present at the specified position or when the transcript view is not available
Parameters
• x: number
X coordinate of the position
• y: number
Y coordinate of the position
Returns
Object containing the viewer objects at the specified position
Inherited from
IOutsideInViewer.getObjectsAtTranscriptPosition
getPageHeight()
getPageHeight(
index?):number
The height of the page, in pixels, at 100% zoom and 0 degrees rotation
Parameters
• index?: number
Optional - if provided, will get height of page at designated index, otherwise will get height of current page
Returns
number
Inherited from
IOutsideInViewer.getPageHeight
getPageRotation()
getPageRotation(
index):number
Gets the page rotations in degrees for a particular page
Parameters
• index: number
Returns
number
Page rotation value
Inherited from
IRotatableViewer.getPageRotation
getPageWidth()
getPageWidth(
index?):number
The width of the page, in pixels, at 100% zoom and 0 degrees rotation
Parameters
• index?: number
Optional - if provided, will get width of page at designated index, otherwise will get width of current page
Returns
number
Inherited from
getSelectionMode()
getSelectionMode():
string
Get the current selection mode
Returns
string
Inherited from
IOutsideInViewer.getSelectionMode
hasFeature()
hasFeature(
featureName):boolean
Checks if the viewer has a specific feature enabled
Parameters
• featureName: "transcript"
The name of the feature to check
Returns
boolean
True if the feature is available, false otherwise
Inherited from
hasPaging()
hasPaging():
boolean
Checks if the current document supports page navigation
Returns
boolean
Inherited from
moveToNextPage()
moveToNextPage():
void
Moves to the next page on the OI Doc
Returns
void
Remarks
Rendering is asynchronous while the call to move to page is synchronous
Inherited from
IOutsideInViewer.moveToNextPage
moveToPage()
moveToPage(
pageIndex):void
Moves to pageIndex if exists in the OI document.
Parameters
• pageIndex: number
Index of target page. This index is 0-based.
Returns
void
Remarks
Rendering is asynchronous while the call to move to page is synchronous
Inherited from
moveToPreviousPage()
moveToPreviousPage():
void
Moves to the previous page on the OI Doc
Returns
void
Remarks
Rendering is asynchronous while the call to move to page is synchronous
Inherited from
IOutsideInViewer.moveToPreviousPage
off()
off(
eventType,handler?,once?):void
Unregisters an event handler
Parameters
• eventType: ViewerHighlightEventType
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)
Returns
void
Inherited from
on()
on(
eventType,handler):void
Registers an event handler
Parameters
• eventType: ViewerHighlightEventType
Event to listen for
• handler: EventHandler
Event handler function
Returns
void
Inherited from
once()
once(
eventType,handler):void
Registers an event handler that is only run once
Parameters
• eventType: ViewerHighlightEventType
Event to listen for
• handler: EventHandler
Event handler function
Returns
void
Inherited from
openAboutModal()
openAboutModal():
Promise<DialogCancellableOpenResult>
Opens the About Viewer Modal
Returns
Promise<DialogCancellableOpenResult>
Inherited from
IOutsideInViewer.openAboutModal
openConfirmDeleteImagesModal()
openConfirmDeleteImagesModal():
Promise<void>
Opens the Confirm Delete Images modal *
Returns
Promise<void>
Inherited from
IOutsideInViewer.openConfirmDeleteImagesModal
openSaveAsPdfModal()
openSaveAsPdfModal():
Promise<DialogCancellableOpenResult>
Opens the Save as PDF Modal
Returns
Promise<DialogCancellableOpenResult>
Inherited from
IOutsideInViewer.openSaveAsPdfModal
openSingleFileUploadModal()
openSingleFileUploadModal(
isImage,imagesExist?,imagingProfileId?):Promise<void>
Opens the Single File Upload modal
Parameters
• isImage: boolean
• imagesExist?: boolean
• imagingProfileId?: number
Returns
Promise<void>
Inherited from
IOutsideInViewer.openSingleFileUploadModal
rotateAllPagesClockwise()
rotateAllPagesClockwise():
Promise<boolean>
Rotates the all pages clockwise 90 degrees based on the current page (The topmost image) orientation and updates the database
Returns
Promise<boolean>
Promise that resolves to a boolean indicating whether it succeeded or not
Inherited from
IRotatableViewer.rotateAllPagesClockwise
rotateCurrentPageClockwise()
rotateCurrentPageClockwise():
Promise<boolean>
Rotates the current page (The topmost image) clockwise 90 degrees and updates the database
Returns
Promise<boolean>
Promise that resolves to a boolean indicating whether it succeeded or not
Inherited from
IRotatableViewer.rotateCurrentPageClockwise
selectCellRange()
selectCellRange(
cellRange):boolean
Makes the specified cell range the active selection
Parameters
• cellRange: CellRangeMemento
Specifies the cell range to select
Returns
boolean
true if the selection changed, false if it did not change
Inherited from
IOutsideInViewer.selectCellRange
selectionRange()
selectionRange():
CellRangeMemento|RectRangeMemento|TextRangeMemento|TimeRangeMemento
Returns a range memento representing currently selected text, rect, or cell
Returns
CellRangeMemento | RectRangeMemento | TextRangeMemento | TimeRangeMemento
Range representing the currently selected text, rect, or cell
Inherited from
IOutsideInViewer.selectionRange
selectRectRange()
selectRectRange(
rectRange):boolean
Makes the specified rect range the active selection
Parameters
• rectRange: RectRangeMemento
Specifies the rect range to select
Returns
boolean
true if the selection changed, false if it did not change
Inherited from
IOutsideInViewer.selectRectRange
selectTextRange()
selectTextRange(
textRange):boolean
Makes the specified text range the active selection
Parameters
• textRange: TextRangeMemento
Specifies the text range to select
Returns
boolean
true if the selection changed, false if it did not change
Inherited from
IOutsideInViewer.selectTextRange
setDesignationRendering()
setDesignationRendering(
designationRendering):void
Sets the designation rendering for the viewer
Parameters
• designationRendering: DesignationRendering
Designation rendering value to use
Returns
void
Inherited from
IOutsideInViewer.setDesignationRendering
setExternalContent()
setExternalContent(
elem,edge?):void
Sets an element to respresent external content which is to be displayed on the requested edge of this view.
Parameters
• elem: HTMLElement
An HTMLElement which represents the desired external content to be displayed.
• edge?: ToolbarLocation
An optional edge (top/left/right/bottom) to display the external content on. If not provided, the default is 'top'.
Returns
void
Inherited from
IOutsideInViewer.setExternalContent
setPageLayoutMode()
setPageLayoutMode(
scrollMode):void
Sets the page layout mode for the current OI View using the passed in value
Parameters
• scrollMode: ViewerScrollMode
scroll mode setting
Returns
void
Inherited from
IOutsideInViewer.setPageLayoutMode
setPageRotation()
setPageRotation(
rotation,index):Promise<boolean>
Sets the page rotation for a particular page and updates the database
Only accepts intervals of 90 degrees
Parameters
• rotation: number
• index: number
Returns
Promise<boolean>
Promise that resolves to a boolean indicating whether it succeeded or not
Inherited from
IRotatableViewer.setPageRotation
setPageRotationAllImages()
setPageRotationAllImages(
rotation):Promise<boolean>
Sets all page rotations for a document and updates the database
Only accepts intervals of 90 degrees
Parameters
• rotation: number
Returns
Promise<boolean>
Promise that resolves to a boolean indicating whether it succeeded or not
Inherited from
IRotatableViewer.setPageRotationAllImages
setSelectionMode()
setSelectionMode(
mode):void
Set a new selection mode
Parameters
• mode: string
Mode to set: rect, text, cell, or none
Returns
void
Inherited from
IOutsideInViewer.setSelectionMode
setTranscriptDesignationRendering()
setTranscriptDesignationRendering(
designationRendering):void
Sets the designation rendering for the associated transcript (if there is one)
Parameters
• designationRendering: DesignationRendering
Designation rendering value to use
If there is no associated transcript or if it has not yet been initialized the provided designation rendering value will be saved and applied when the transcript is initialized.
Returns
void
Inherited from
IOutsideInViewer.setTranscriptDesignationRendering
showBanner()
protectedshowBanner(message,details,level,clickToRemove,link?):void
Method for displaying a banner on the viewer card
Parameters
• message: string
Message to display in the banner
• details: string[]
Details to display in the banner
• level: NotificationLevel
Notification level of banner
• clickToRemove: boolean
Whether the user can click to remove the banner
• link?: LinkOption
An optional link to display in the banner
Returns
void
Inherited from
showHiddenContent()
showHiddenContent(
showHiddenContent):void
Show or hide hidden content in the document
Parameters
• showHiddenContent: boolean
True will show the hidden content and false will hide them
Returns
void
Inherited from
IOutsideInViewer.showHiddenContent
toggleFilterDrawer()
toggleFilterDrawer(
opened):void
Toggles the filter viewer drawer
Parameters
• opened: boolean
Whether the drawer should be opened or not
Returns
void
Inherited from
IOutsideInViewer.toggleFilterDrawer
toggleThumbnails()
toggleThumbnails(
showThumbnails):void
DO NOT DELETE -- Called by embedded Shows or hides the OI Thumbnail view
Parameters
• showThumbnails: boolean
Show or Hide the thumbnail view.
Returns
void
Inherited from
IOutsideInViewer.toggleThumbnails
totalPageCount()
totalPageCount():
number
returns the total number of pages on the current document
Returns
number
Remarks
this will return the total page count for the active viewer's document
Inherited from
IOutsideInViewer.totalPageCount
zoomIn()
zoomIn():
number
Increases the zoom factor of the current view.
Returns
number
The zoom factor after zooming.
Inherited from
zoomOut()
zoomOut():
number
Decreases the zoom factor of the current view.
Returns
number
The zoom factor after zooming.
Inherited from
zoomToFit()
zoomToFit(
zoomMode):number
Zooms the current view based on the ViewerZoomMode enum value provided.
Parameters
• zoomMode: ViewerZoomMode
The Viewer Zoom Mode enum for the view.
Returns
number
The zoom factor after zooming.
Inherited from
zoomToIndex()
zoomToIndex(
zoomIndex):number
Zooms the current view to the factor provided, rounded to the nearest integer. If the zoomIndex provided is greater than the maximum valid zoom factor, the document is zoomed to the maximum valid zoom factor. If the zoomIndex provided is less than the minimum valid zoom factor, the document is zoomed to the minimum valid zoom factor.
Parameters
• zoomIndex: number
The new zoom factor for the view.
Returns
number
The zoom factor after zooming.
Inherited from
On this page
- Interface: IProductionViewer
- Extends
- Properties
- cardActivated()?
- cardBuildTabOptions()?
- cardBuildToolbarOptions()?
- cardCanDeactivate()?
- cardCreateUnsupportedOverlayCard()?
- cardDeactivated()?
- cardError()?
- cardLoaded()?
- cardLoadState()?
- cardMaximized()?
- cardResized()?
- cardRestored()?
- cardSaveState()?
- cardUnloaded()?
- contextualSearchView
- currentPageIndex
- currentPageName
- designationRendering
- hasWaveform
- highlights
- id
- loadError
- loadSuccessful
- oiPagesLoadedCount
- shouldHighlight
- showWaveformView
- thumbnailView
- timelineView
- transcriptDesignationRendering
- transcriptView
- transientHighlight
- type
- unsupportedTabTitle?
- Methods
- cardLoadItem()
- checkHasFeature()
- createCellRange()
- createRectRange()
- createTextRange()
- getAquaView()
- getExternalContent()
- getFeatureManager()
- getHiddenContentStatus()
- getObjectsAtPosition()
- getObjectsAtTranscriptPosition()
- getPageHeight()
- getPageRotation()
- getPageWidth()
- getSelectionMode()
- hasFeature()
- hasPaging()
- moveToNextPage()
- moveToPage()
- moveToPreviousPage()
- off()
- on()
- once()
- openAboutModal()
- openConfirmDeleteImagesModal()
- openSaveAsPdfModal()
- openSingleFileUploadModal()
- rotateAllPagesClockwise()
- rotateCurrentPageClockwise()
- selectCellRange()
- selectionRange()
- selectRectRange()
- selectTextRange()
- setDesignationRendering()
- setExternalContent()
- setPageLayoutMode()
- setPageRotation()
- setPageRotationAllImages()
- setSelectionMode()
- setTranscriptDesignationRendering()
- showBanner()
- showHiddenContent()
- toggleFilterDrawer()
- toggleThumbnails()
- totalPageCount()
- zoomIn()
- zoomOut()
- zoomToFit()
- zoomToIndex()
