Global

Members

disableErrorModals :object

This is an object that stores many booleans, each one related to a set of error modals. If true, then modals will not pop up for the selected modals. NOTE: server and client are hammer options and should probably not be used unless you want to disable EVERYTHING from that origin.
Type:
  • object
Properties:
Name Type Description
server boolean Disable all modals originating from the server
client boolean Disable all modals originating from the client
adminDisabled boolean Disable all modals that tell the users that the administrator blocked this action
annotations boolean Disable all modals originating from annotations
bookmark boolean Disable all modals originating from Bookmars
cropBlock boolean Disable all modals originating from cropping
documentNotFound boolean Disable modals telling the user that a document was not found
export boolean Disable modals telling the user that an export operation failed
IEImageLoadError boolean Disable all modals originating from IE
imageFailedToLoad boolean Disable all modals originating from the image failing to load
media boolean Disable all modals originating from media errors, for example video and audio playback
pageLimit boolean Disable all modals originating from hitting a page limit
pageManipulation boolean Disable all modals originating from cut/copy/paste
print boolean Disable all modals originating from printing
splitScreen boolean Disable all modals originating from split screen
tabs boolean Disable all modals originating from document tabs
xlsxPageLimited boolean Disable all modals originating from XLSX limiting

Type Definitions

annotationProperties

Properties:
Name Type Description
lineColor string A hex color value, absent the leading hash, for the line color of annotations. For instance, "00FF00". This will not be used for filled annotation types.
lineWidth string In pixels, the default line width for annotations without fill.
fillCollor string A hex color value, absent the leading hash, for the fill color of annotations. For instance, "00FF00". This will not be used for unfilled annotation types.
stickyFillColor string A hex color value, absent the leading hash, for the fill color of sticky note annotations specifically. For instance, "00FF00".
stickyMargin number The margin, in pixels, around the text in a sticky note annotation.
highlightFillColor string A hex color value, absent the leading hash, for the fill color of highlight annotations specifically. For instance, "00FF00".
highlightOpacity number A percentage, in decimal form, of the opacity of a highlight annotation. For instance, 0.5 for 50% opacity.
redactionFillColor string A hex color value, absent the leading hash, for the fill color of redactions specifically. For instance, "000000".
redactionOpacity number A percentage, in decimal form, of the opacity of an in-progress redaction annotation. For instance, 0.5 for 50% opacity. Burned redactions will be fully opaque, but this value can configure the transparency of a redaction that is not yet burned into the image.
textString string The default initial text for a text annotation or sticky note annotation.
fontFace string The font of the text in a text annotation or sticky note annotation.
fontSize number The size of the text in a text annotation or sticky note annotation.
fontBold boolean Whether the font in a text annotation or sticky note annotation is bolded.
fontItalic boolean Whether the font in a text annotation or sticky note annotation is italicized.
fontColor string A hex color value, absent the leading hash, for the font color of text in annotations. For instance, "00FF00".

Hotkey

A VirtualViewer-specific hotkey.
Type:
  • object
Properties:
Name Type Description
key string Define one or more key patterns, separated by commas, as the hotkey.
method function The method triggered by the hotkey.
localizedValue string A reference to a locale json file, defining the displayed text of the hotkey hint.
defaultValue string A default hotkey hint.

ImageInfoField

Type:
  • object
Properties:
Name Type Description
fieldId string The ID of the field. This should never be changed.
fieldCaption string The caption of the field displayed in the Image Info dialog.

ImageStamp

Data used to load an image rubber stamp.
Type:
  • object
Properties:
Name Type Attributes Default Description
stampTitle string The displayed title of the image stamp.
url string The URI from which to load the stamp image.
width number <optional>
The internally-defined width of the image The width of the image.
height number <optional>
The internally-defined height of the image The height of the image.

noteTemplate

A pre-written document note.
Type:
  • object
Properties:
Name Type Description
noteTemplate.templateName string The displayed name of the template.
noteTemplate.templateString string The contents of the document note.

zoomDocumentError(args)

This callback function is called when the zoom action encounters a handled error, for example if the zoom action would zoom in more than the maximum allowed zoom percent.
Parameters:
Name Type Description
args object
Properties
Name Type Description
documentId string The ID of the zoomed document.
currentZoom number The current percent zoom of the document--eg 50 for a 50% zoom.
newZoom number The proposed new percent zoom of the document.
exceptionMessage string A brief description of the error encountered.