Interface: IOutsideInViewer

OutsideIn viewer instance interface

Remarks

This provides a special bootstrap method that can take in an OutsideIn View instance.

Extends

IViewerCardInstance

Extended by

Properties

cardActivated()?

optionalcardActivated: (api, card) => void

Called after the card is activated in a dock.

Parameters

• api: IReviewInterfaceApi

• card: ICard

Returns

void

Inherited from

IViewerCardInstance.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

IViewerCardInstance.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

IViewerCardInstance.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

IViewerCardInstance.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

IViewerCardInstance.cardCreateUnsupportedOverlayCard

cardDeactivated()?

optionalcardDeactivated: (api, card) => void

Called after the card is deactivated in a dock.

Parameters

• api: IReviewInterfaceApi

• card: ICard

Returns

void

Inherited from

IViewerCardInstance.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

IViewerCardInstance.cardError

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

IViewerCardInstance.cardLoaded

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

IViewerCardInstance.cardLoadState

cardMaximized()?

optionalcardMaximized: (api, card) => void

Called when the card is maximized

Parameters

• api: IReviewInterfaceApi

• card: ICard

Returns

void

Inherited from

IViewerCardInstance.cardMaximized

cardResized()?

optionalcardResized: (api, card) => void

Called when the card is resized

Parameters

• api: IReviewInterfaceApi

• card: ICard

Returns

void

Inherited from

IViewerCardInstance.cardResized

cardRestored()?

optionalcardRestored: (api, card) => void

Called when the card is no longer maximized

Parameters

• api: IReviewInterfaceApi

• card: ICard

Returns

void

Inherited from

IViewerCardInstance.cardRestored

cardSaveState()?

optionalcardSaveState: (api, card) => ICardCustomState

Called to save the state of the card

Parameters

• api: IReviewInterfaceApi

• card: ICard

Returns

ICardCustomState

Inherited from

IViewerCardInstance.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

IViewerCardInstance.cardUnloaded

contextualSearchView

readonlycontextualSearchView: BasicView

Contextual Search View

currentPageIndex

currentPageIndex: number

Gets the current page index.

currentPageName

currentPageName: string

Gets the current page name

designationRendering

readonlydesignationRendering: DesignationRendering

The current designation rendering for the viewer or undefined if none is set

hasWaveform

readonlyhasWaveform: boolean

Checks if the current native supports the waveform view

id

readonlyid: string

Unique viewer instance ID

Inherited from

IViewerCardInstance.id

loadError

readonlyloadError: Error

Populated with error when loadSuccessful is false. Otherwise, undefined.

loadSuccessful

readonlyloadSuccessful: boolean

Returns true, if document was loaded into view without error.

oiPagesLoadedCount

oiPagesLoadedCount: number

Gets the current number of loaded pages for the current document.

showWaveformView

showWaveformView: boolean

Gets or sets the waveform viewer for multimedia

thumbnailView

readonlythumbnailView: BasicView

The Thumbnail viewer for the view

timelineView

readonlytimelineView: BasicView

The Timeline viewer for the view

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.

transcriptView

readonlytranscriptView: View

The Transcript viewer for the view

transientHighlight

readonlytransientHighlight: ITransientHighlightManager

The Transient Highlight Manager for the view

type

readonlytype: string

Viewer type - this should match the viewer type from the configuration object

Inherited from

IViewerCardInstance.type

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

IViewerCardInstance.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

IViewerCardInstance.cardLoadItem

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

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

CellRangeMemento

CellRangeMoment object built with the provided arguments

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

RectRangeMemento

RectRangeMoment object built with the provided arguments

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

TextRangeMemento

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>

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.

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

getHiddenContentStatus()

getHiddenContentStatus(): HiddenContentType

Returns Outside In Show/Hide hidden Items status

Returns

HiddenContentType

The status of hidden content shown in the viewer (On or Off)

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

IViewerObjects

Object containing the viewer objects at the specified position

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

IViewerObjects

Object containing the viewer objects at the specified position

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

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

getSelectionMode()

getSelectionMode(): string

Get the current selection mode

Returns

string

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

hasPaging()

hasPaging(): boolean

Checks if the current document supports page navigation

Returns

boolean

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

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

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

openAboutModal()

openAboutModal(): Promise<DialogCancellableOpenResult>

Opens the About Viewer Modal

Returns

Promise<DialogCancellableOpenResult>

openConfirmDeleteImagesModal()

openConfirmDeleteImagesModal(): Promise<void>

Opens the Confirm Delete Images modal *

Returns

Promise<void>

openSaveAsPdfModal()

openSaveAsPdfModal(): Promise<DialogCancellableOpenResult>

Opens the Save as PDF Modal

Returns

Promise<DialogCancellableOpenResult>

openSingleFileUploadModal()

openSingleFileUploadModal(isImage, imagesExist?, imagingProfileId?): Promise<void>

Opens the Single File Upload modal

Parameters

• isImage: boolean

• imagesExist?: boolean

• imagingProfileId?: number

Returns

Promise<void>

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

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

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

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

setDesignationRendering()

setDesignationRendering(designationRendering): void

Sets the designation rendering for the viewer

Parameters

• designationRendering: DesignationRendering

Designation rendering value to use

Returns

void

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

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

setSelectionMode()

setSelectionMode(mode): void

Set a new selection mode

Parameters

• mode: string

Mode to set: rect, text, cell, or none

Returns

void

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

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

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

toggleFilterDrawer()

toggleFilterDrawer(opened): void

Toggles the filter viewer drawer

Parameters

• opened: boolean

Whether the drawer should be opened or not

Returns

void

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

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

zoomIn()

zoomIn(): number

Increases the zoom factor of the current view.

Returns

number

The zoom factor after zooming.

zoomOut()

zoomOut(): number

Decreases the zoom factor of the current view.

Returns

number

The zoom factor after zooming.

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.

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.

Additional Resources
Developer Group	GitHub	Release Notes	NuGet