Artifact ID of the active Relativity IMarkupSet
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
Gets the current page index.
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
ID of the instance
Whether or not the viewer instance has been bootstrapped
Populated with error when loadSuccessful is false. Otherwise, undefined.
Returns true, if document was loaded into view without error.
Name of the viewer instance
Gets the current number of loaded pages for the current document.
The text that will be used to populate text redactions
This is defaulted to the user's default value when the IViewerInstance is bootstrapped.
The size of the text on text redactions.
This is defaulted to the user's default value when the 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
Returns true if thumbnails are visible
Gets the number of images for the current document
Viewer type
Activate lifecycle method that is invoked when the instance is becoming the IViewerCollection's active viewer
Promise that is resolved once activation is complete.
Bootstrap lifecycle method for one-time setup of the viewer instance.
This method is called after the instance's DOM element has been setup, but before any documents are loaded.
ID of the viewer instance's DOM element
The viewer collection the instance belongs to
Promise that is resolved once bootstrapping is complete.
CanDeactivate lifecycle method that is invoked when the IViewerCollection needs to determine if it is safe to unload a document
Whether or not it is safe to load a new item, deactivate the viewer, or teardown the viewer.
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
Deactivate lifecycle method that is invoked when the instance is no longer the IViewerCollection's active viewer
Promise that is resolved once deactivation is complete.
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
Gets the page rotations in degrees for a particular page
Page rotation value
Gets an array of IAnnotation selected in the UI
Array of IAnnotation containing all annotations selected in the UI
Hides the displayed IAnnotations
Load lifecycle method that is invoked when the viewer instance should load a document from the queue
Item to be loaded and displayed to the user
Promise that is resolved once the item has been loaded.
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
Deletes IAnnotations on the current document if they are on the specified page and is included as a type
Pages the annotations will be created on (Pages are 0-indexed)
Annotation type(s)
Flag for distinguising between full-page and non-full-page redactions
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 Hydro Modal
Opens the Edit Text Redaction 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
Reload lifecycle method that is invoked when the viewer instance should refresh all of it's data before reloading the current queue item
Promise that is resolved once the reload is complete.
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 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.
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
Shows the displayed IAnnotations
Teardown lifecycle method for one-time teardown of the viewer instance.
This method is called when the IViewerCollection is being torn down.
Promise that is resolved once teardown is complete.
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%.
Toggles Outside In Thumbnails functionality based on thumbnailsVisible property
returns the total number of pages on the current document
Changes the IAnnotation opacity to be 30%.
Updates an IAnnotation on the current document
Annotation to update
Updates IAnnotations on the current document
Annotations to update
Image Viewer IViewerInstance