Artifact ID of the active Relativity IMarkupSet
Gets the number of annotations for the current IQueueItem
When the drawing tool type is DrawingToolType.Annotation, this drives whether a full page redaction is created on click.
This is undefined when the drawing tool type is DrawingToolType.Selection
When the drawing tool type is DrawingToolType.Annotation, this drives the sub-type of Relativity markup that is created on click.
When the annotation type is AnnotationType.Highlight, this must be a HighlightSubType and when the annotation type is AnnotationType.Redaction, this must be a RedactionSubType.
When the drawing tool type is DrawingToolType.Annotation, this drives the type of Relativity markup that is created on click.
This is undefined when the drawing tool type is DrawingToolType.Selection
Called after the card is activated in a dock.
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.
If provided, this function will be called to build custom viewer toolbar options for the viewer card.
Called before the card deactivates to check if it is safe to do so
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.
Called after the card is deactivated in a dock.
Called whenever an error occurs while managing the card
Called to restore the state of the card
Called after the card content has loaded
Called when the card is maximized
Called when the card is resized
Called when the card is no longer maximized
Called to save the state of the card
Called before the card content is unloaded
Contextual Search View
Gets the current page index.
Gets the current page name
Tool type that determines mouse click behavior on the document
Whether or not highlight controls are enabled
This is based on user's highlight permissions and whether the user has access to at least one IMarkupSet
Unique viewer instance ID
Populated with error when loadSuccessful is false. Otherwise, undefined.
Returns true, if document was loaded into view without error.
Gets the AnnotationVisibilityType based on the current redaction opactiy
Gets the current number of loaded pages for the current document.
The annotation highlight color last selected
The annotation redaction mode last selected
The annotation redaction type last selected
The text that will be used to populate text redactions
This is defaulted to the user's default value when the {@link IViewerInstance} is bootstrapped.
The size of the text on text redactions.
This is defaulted to the user's default value when the {@link IViewerInstance} is bootstrapped.
Whether or not redaction controls are enabled
This is based on user's redaction permissions and whether the user has access to at least one IMarkupSet
The Thumbnail viewer for the view
The Timeline viewer for the view
Gets the number of images for the current IQueueItem
The Transient Highlight Manager for the view
Viewer type - this should match the viewer type from the configuration object
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
Called when the viewer card should load a new queue item
Queue item to be loaded
Load options
Promise that resolves to a boolean indicating whether or not the load was successful
Checks the OI Aqua API to see whether the viewer's current state can support the specified feature
The ViewFeature (enum) being checked
Whether or not the viewer can support the specified feature
Creates an IAnnotation on the current document
Page the annotation will be created on (Pages are 0-indexed)
Annotation type
Annotation sub-type
Annotation location
Promise that is resolved to the created annotation
Creates a CellRangeMemento representing the cell or range of cells at the specified spreadsheet or database table, row(s), and column(s).
The 0-based index of the page containing the range
The 0-based index of the leftmost column of the range
The 0-based index of the topmost row of the range
CellRangeMoment object built with the provided arguments
Creates a full page IAnnotation with the most recent full-page redaction settings. If there are no recent full-page redaction settings, we will create a black full-page redaction.
If creation fails this method will throw and the user will be notified via a banner and console errors.
Creates a RectRangeMemento representing a rectangle on the specified page
The 0-based index of the page containing the range
The left edge of the rectangular range
The top edge of the rectangular range
RectRangeMoment object built with the provided arguments
Creates a TextRangeMemento corresponding to the specified ACC (actual character count) range
The first character of the ACC range (inclusive)
The last character of the ACC range (non-inclusive)
Deletes All IAnnotations on the current IQueueItem
If deletion fails this method will throw and the user will be notified via a banner and console errors.
Deletes an IAnnotation on the current document
If deletion fails this method will throw and the user will be notified via a banner and console errors.
Annotation to delete
Deletes IAnnotations on the current document if they are on the specified page and are the same type/subtype
If deletion fails this method will throw and the user will be notified via a banner and console errors.
Pages the annotations will be created on (Pages are 0-indexed)
Annotation type
Annotation sub-type
Deletes IAnnotations on the current document
If deletion fails this method will throw and the user will be notified via a banner and console errors.
Annotations to delete
Deselects all IAnnotations in the UI
Rendering is asynchronous while the call deselect is synchronous
Returns Outside In Show/Hide hidden Items status
The status of hidden content shown in the viewer (On or Off)
The height of the page, in pixels, at 100% zoom and 0 degrees rotation
Optional - if provided, will get height of page at designated index, otherwise will get height of current page
Gets the page rotations in degrees for a particular page
Page rotation value
The width of the page, in pixels, at 100% zoom and 0 degrees rotation
Optional - if provided, will get width of page at designated index, otherwise will get width of current page
Gets an array of IAnnotation selected in the UI
Array of IAnnotation containing all annotations selected in the UI
Get the current selection mode
Checks if the current document supports page navigation
Hides the displayed IAnnotations
Creates an IAnnotation on the current document at the same location across multiple pages
Pages the annotations will be created on (Pages are 0-indexed)
Annotation type
Annotation sub-type
Annotation location
Promise that is resolved to the created annotations
Moves to the next page on the OI Doc
Moves to pageIndex if exists in the OI document.
Index of target page. This index is 0-based.
Moves to the previous page on the OI Doc
Opens the About Viewer Modal
Opens the Confirm Delete Images modal
Opens the Mass Redact Images Modal
Optional parameter to pre-select the Redaction Type in the Mass Redact modal
Opens the Edit Text Redaction Modal
Current text of the annotation
Array of annotations to edit
Opens the Mass Delete Markup Modal
Opens the Save as PDF Modal
Opens the Single File Upload modal
Persists the highlight color dropdown selection
Highlight Color selection
Persists the redaction mode dropdown selection
Redaction Mode selection
Persists the redaction type dropdown selection
Redaction Type selection
Reloads all IAnnotations on the page after getting the annotations from the server.
Rotates the all pages clockwise 90 degrees based on the current page (The topmost image) orientation and updates the database
Promise that resolves to a boolean indicating whether it succeeded or not
Rotates the current page (The topmost image) clockwise 90 degrees and updates the database
Promise that resolves to a boolean indicating whether it succeeded or not
selects all IAnnotations in the UI
Array of IAnnotation containing all annotations selected in the UI
Selects correlating IAnnotation from the IMarkupSet in the UI
Artifact ID of markup set the redaction is in
Artifact ID of annotation to be selected
Promise that is resolved after the annotation has been selected and scrolled into view OR throws an error if the Annotation does not exist or the selection fails.
Makes the specified cell range the active selection
Specifies the cell range to select
true if the selection changed, false if it did not change
Makes the specified rect range the active selection
Specifies the rect range to select
true if the selection changed, false if it did not change
Makes the specified text range the active selection
Specifies the text range to select
true if the selection changed, false if it did not change
Returns a range memento representing currently selected text, rect, or cell
Range representing the currently selected text, rect, or cell
Updates the active IMarkupSet
Artifact ID of the Relativity IMarkupSet
Promise that is resolved when the update is complete and all IAnnotations have been loaded
Updates the active DrawingToolType
Tool type
Sets the page layout mode for the current OI View using the passed in value
scroll mode setting
Sets the page rotation for a particular page and updates the database
Only accepts intervals of 90 degrees
Promise that resolves to a boolean indicating whether it succeeded or not
Sets all page rotations for a document and updates the database
Only accepts intervals of 90 degrees
Promise that resolves to a boolean indicating whether it succeeded or not
Set a new selection mode
Mode to set: rect, text, cell, or none
Show or hide hidden content in the document
Shows the displayed IAnnotations
Toggles the filter viewer drawer
Whether the drawer should be opened or not
Toggles the opacity of all IAnnotations being shown.
When first invoked, the opacity is changed to be 30%. When invoked for the second time, the opacity is changed to be 0%. When invoked a third time, the opacity is restored to 100%.
DO NOT DELETE -- Called by embedded Shows or hides the OI Thumbnail view
Show or Hide the thumbnail view.
returns the total number of pages on the current document
Changes the IAnnotation opacity to be 30%.
Updates an IAnnotation on the current IQueueItem
Annotation to update
Updates IAnnotations on the current document
Annotations to update
Increases the zoom factor of the current view.
The zoom factor after zooming.
Decreases the zoom factor of the current view.
The zoom factor after zooming.
Zooms the current view based on the ViewerZoomMode enum value provided.
The Viewer Zoom Mode enum for the view.
The zoom factor after zooming.
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.
The new zoom factor for the view.
The zoom factor after zooming.
Image Viewer {@link IViewerInstance}