| Server IP : 212.252.79.165 / Your IP : 216.73.217.172 [ Web Server : Apache System : Linux 212-252-79-165.cprapid.com 5.15.0-153-generic #163-Ubuntu SMP Thu Aug 7 16:37:18 UTC 2025 x86_64 User : cehaburo ( 1001) PHP Version : 8.1.33 Disable Function : exec,passthru,shell_exec,system Domains : 48 Domains MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /home/cehaburo/www/pdfjs/doc/ |
Upload File : |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>PDFJS Express WebViewer Class: DocumentViewer</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.pdftron.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top ">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">PDFJS Express WebViewer</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="Core.html">Core</a></li><li><a href="Core.Actions.html">Core.Actions</a></li><li><a href="Core.Annotations.html">Core.Annotations</a></li><li><a href="Core.ContentEdit.html">Core.ContentEdit</a></li><li><a href="Core.Math.html">Core.Math</a></li><li><a href="Core.PartRetrievers.html">Core.PartRetrievers</a></li><li><a href="Core.Search.html">Core.Search</a></li><li><a href="Core.Tools.html">Core.Tools</a></li><li><a href="UI.html">UI</a></li><li><a href="UI.Fonts.html">UI.Fonts</a></li><li><a href="UI.Hotkeys.html">UI.Hotkeys</a></li><li><a href="UI.NotesPanel.html">UI.NotesPanel</a></li><li><a href="UI.TabManager.html">UI.TabManager</a></li><li><a href="UI.ThumbnailsPanel.html">UI.ThumbnailsPanel</a></li><li><a href="UI.VerificationOptions.html">UI.VerificationOptions</a></li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="Core.Actions.Action.html">Core.Actions.Action</a></li><li><a href="Core.Actions.Dest.html">Core.Actions.Dest</a></li><li><a href="Core.Actions.GoTo.html">Core.Actions.GoTo</a></li><li><a href="Core.Actions.GoToR.html">Core.Actions.GoToR</a></li><li><a href="Core.Actions.Hide.html">Core.Actions.Hide</a></li><li><a href="Core.Actions.JavaScript.html">Core.Actions.JavaScript</a></li><li><a href="Core.Actions.Named.html">Core.Actions.Named</a></li><li><a href="Core.Actions.ResetForm.html">Core.Actions.ResetForm</a></li><li><a href="Core.Actions.SubmitForm.html">Core.Actions.SubmitForm</a></li><li><a href="Core.Actions.URI.html">Core.Actions.URI</a></li><li><a href="Core.AnnotationHistoryManager.html">Core.AnnotationHistoryManager</a></li><li><a href="Core.AnnotationManager.html">Core.AnnotationManager</a></li><li><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></li><li><a href="Core.Annotations.ArcAnnotation.html">Core.Annotations.ArcAnnotation</a></li><li><a href="Core.Annotations.Border.html">Core.Annotations.Border</a></li><li><a href="Core.Annotations.BoxControlHandle.html">Core.Annotations.BoxControlHandle</a></li><li><a href="Core.Annotations.BoxSelectionModel.html">Core.Annotations.BoxSelectionModel</a></li><li><a href="Core.Annotations.ButtonWidgetAnnotation.html">Core.Annotations.ButtonWidgetAnnotation</a></li><li><a href="Core.Annotations.CalloutControlHandle.html">Core.Annotations.CalloutControlHandle</a></li><li><a href="Core.Annotations.CalloutSelectionModel.html">Core.Annotations.CalloutSelectionModel</a></li><li><a href="Core.Annotations.CanvasHelper.html">Core.Annotations.CanvasHelper</a></li><li><a href="Core.Annotations.CaretAnnotation.html">Core.Annotations.CaretAnnotation</a></li><li><a href="Core.Annotations.CheckButtonWidgetAnnotation.html">Core.Annotations.CheckButtonWidgetAnnotation</a></li><li><a href="Core.Annotations.ChoiceWidgetAnnotation.html">Core.Annotations.ChoiceWidgetAnnotation</a></li><li><a href="Core.Annotations.Color.html">Core.Annotations.Color</a></li><li><a href="Core.Annotations.ControlHandle.html">Core.Annotations.ControlHandle</a></li><li><a href="Core.Annotations.CustomAnnotation.html">Core.Annotations.CustomAnnotation</a></li><li><a href="Core.Annotations.DatePickerWidgetAnnotation.html">Core.Annotations.DatePickerWidgetAnnotation</a></li><li><a href="Core.Annotations.EllipseAnnotation.html">Core.Annotations.EllipseAnnotation</a></li><li><a href="Core.Annotations.FileAttachmentAnnotation.html">Core.Annotations.FileAttachmentAnnotation</a></li><li><a href="Core.Annotations.Font.html">Core.Annotations.Font</a></li><li><a href="Core.Annotations.Forms.html">Core.Annotations.Forms</a></li><li><a href="Core.Annotations.Forms.EmbeddedJS.html">Core.Annotations.Forms.EmbeddedJS</a></li><li><a href="Core.Annotations.Forms.Field.html">Core.Annotations.Forms.Field</a></li><li><a href="Core.Annotations.Forms.FieldManager.html">Core.Annotations.Forms.FieldManager</a></li><li><a href="Core.Annotations.FreeHandAnnotation.html">Core.Annotations.FreeHandAnnotation</a></li><li><a href="Core.Annotations.FreeTextAnnotation.html">Core.Annotations.FreeTextAnnotation</a></li><li><a href="Core.Annotations.FreeTextAnnotation.RichTextEditor.html">Core.Annotations.FreeTextAnnotation.RichTextEditor</a></li><li><a href="Core.Annotations.FreeTextSelectionModel.html">Core.Annotations.FreeTextSelectionModel</a></li><li><a href="Core.Annotations.HTMLAnnotation.html">Core.Annotations.HTMLAnnotation</a></li><li><a href="Core.Annotations.IPathAnnotation.html">Core.Annotations.IPathAnnotation</a></li><li><a href="Core.Annotations.LineAnnotation.html">Core.Annotations.LineAnnotation</a></li><li><a href="Core.Annotations.LineControlHandle.html">Core.Annotations.LineControlHandle</a></li><li><a href="Core.Annotations.LineSelectionModel.html">Core.Annotations.LineSelectionModel</a></li><li><a href="Core.Annotations.Link.html">Core.Annotations.Link</a></li><li><a href="Core.Annotations.ListWidgetAnnotation.html">Core.Annotations.ListWidgetAnnotation</a></li><li><a href="Core.Annotations.MarkupAnnotation.html">Core.Annotations.MarkupAnnotation</a></li><li><a href="Core.Annotations.Model3D.html">Core.Annotations.Model3D</a></li><li><a href="Core.Annotations.PathControlHandle.html">Core.Annotations.PathControlHandle</a></li><li><a href="Core.Annotations.PathSelectionModel.html">Core.Annotations.PathSelectionModel</a></li><li><a href="Core.Annotations.PolygonAnnotation.html">Core.Annotations.PolygonAnnotation</a></li><li><a href="Core.Annotations.PolygonControlHandle.html">Core.Annotations.PolygonControlHandle</a></li><li><a href="Core.Annotations.PolygonSelectionModel.html">Core.Annotations.PolygonSelectionModel</a></li><li><a href="Core.Annotations.PolylineAnnotation.html">Core.Annotations.PolylineAnnotation</a></li><li><a href="Core.Annotations.PopupAnnotation.html">Core.Annotations.PopupAnnotation</a></li><li><a href="Core.Annotations.RadioButtonWidgetAnnotation.html">Core.Annotations.RadioButtonWidgetAnnotation</a></li><li><a href="Core.Annotations.RectangleAnnotation.html">Core.Annotations.RectangleAnnotation</a></li><li><a href="Core.Annotations.RedactionAnnotation.html">Core.Annotations.RedactionAnnotation</a></li><li><a href="Core.Annotations.RedactionSelectionModel.html">Core.Annotations.RedactionSelectionModel</a></li><li><a href="Core.Annotations.RotationControlHandle.html">Core.Annotations.RotationControlHandle</a></li><li><a href="Core.Annotations.RotationUtils.html">Core.Annotations.RotationUtils</a></li><li><a href="Core.Annotations.SelectionAlgorithm.html">Core.Annotations.SelectionAlgorithm</a></li><li><a href="Core.Annotations.SelectionModel.html">Core.Annotations.SelectionModel</a></li><li><a href="Core.Annotations.SignatureWidgetAnnotation.html">Core.Annotations.SignatureWidgetAnnotation</a></li><li><a href="Core.Annotations.SoundAnnotation.html">Core.Annotations.SoundAnnotation</a></li><li><a href="Core.Annotations.StampAnnotation.html">Core.Annotations.StampAnnotation</a></li><li><a href="Core.Annotations.StickyAnnotation.html">Core.Annotations.StickyAnnotation</a></li><li><a href="Core.Annotations.TextHighlightAnnotation.html">Core.Annotations.TextHighlightAnnotation</a></li><li><a href="Core.Annotations.TextMarkupAnnotation.html">Core.Annotations.TextMarkupAnnotation</a></li><li><a href="Core.Annotations.TextRedactAnnotation.html">Core.Annotations.TextRedactAnnotation</a></li><li><a href="Core.Annotations.TextSelectionModel.html">Core.Annotations.TextSelectionModel</a></li><li><a href="Core.Annotations.TextSquigglyAnnotation.html">Core.Annotations.TextSquigglyAnnotation</a></li><li><a href="Core.Annotations.TextStrikeoutAnnotation.html">Core.Annotations.TextStrikeoutAnnotation</a></li><li><a href="Core.Annotations.TextUnderlineAnnotation.html">Core.Annotations.TextUnderlineAnnotation</a></li><li><a href="Core.Annotations.TextWidgetAnnotation.html">Core.Annotations.TextWidgetAnnotation</a></li><li><a href="Core.Annotations.WidgetAnnotation.html">Core.Annotations.WidgetAnnotation</a></li><li><a href="Core.Annotations.WidgetFlags.html">Core.Annotations.WidgetFlags</a></li><li><a href="Core.Annotations.XFDFUtils.html">Core.Annotations.XFDFUtils</a></li><li><a href="Core.Bookmark.html">Core.Bookmark</a></li><li><a href="Core.DisplayMode.html">Core.DisplayMode</a></li><li><a href="Core.DisplayModeManager.html">Core.DisplayModeManager</a></li><li><a href="Core.Document.html">Core.Document</a></li><li><a href="Core.DocumentViewer.html">Core.DocumentViewer</a></li><li><a href="Core.EditBoxManager.html">Core.EditBoxManager</a></li><li><a href="Core.EventHandler.html">Core.EventHandler</a></li><li><a href="Core.Math.Matrix.html">Core.Math.Matrix</a></li><li><a href="Core.Math.Point.html">Core.Math.Point</a></li><li><a href="Core.Math.Quad.html">Core.Math.Quad</a></li><li><a href="Core.Math.Rect.html">Core.Math.Rect</a></li><li><a href="Core.Math.TransformationBuilder.html">Core.Math.TransformationBuilder</a></li><li><a href="Core.MeasurementManager.html">Core.MeasurementManager</a></li><li><a href="Core.PartRetrievers.PartRetriever.html">Core.PartRetrievers.PartRetriever</a></li><li><a href="Core.Scale.html">Core.Scale</a></li><li><a href="Core.Tools.AnnotationEditTool.html">Core.Tools.AnnotationEditTool</a></li><li><a href="Core.Tools.AnnotationSelectTool.html">Core.Tools.AnnotationSelectTool</a></li><li><a href="Core.Tools.ArcCreateTool.html">Core.Tools.ArcCreateTool</a></li><li><a href="Core.Tools.ArcMeasurementCreateTool.html">Core.Tools.ArcMeasurementCreateTool</a></li><li><a href="Core.Tools.AreaMeasurementCreateTool.html">Core.Tools.AreaMeasurementCreateTool</a></li><li><a href="Core.Tools.ArrowCreateTool.html">Core.Tools.ArrowCreateTool</a></li><li><a href="Core.Tools.CalloutCreateTool.html">Core.Tools.CalloutCreateTool</a></li><li><a href="Core.Tools.ChangeViewCreateTool.html">Core.Tools.ChangeViewCreateTool</a></li><li><a href="Core.Tools.CheckBoxFormFieldCreateTool.html">Core.Tools.CheckBoxFormFieldCreateTool</a></li><li><a href="Core.Tools.CloudyRectangularAreaMeasurementTool.html">Core.Tools.CloudyRectangularAreaMeasurementTool</a></li><li><a href="Core.Tools.ComboBoxFormFieldCreateTool.html">Core.Tools.ComboBoxFormFieldCreateTool</a></li><li><a href="Core.Tools.ContentEditTool.html">Core.Tools.ContentEditTool</a></li><li><a href="Core.Tools.CountMeasurementCreateTool.html">Core.Tools.CountMeasurementCreateTool</a></li><li><a href="Core.Tools.DateFreeTextCreateTool.html">Core.Tools.DateFreeTextCreateTool</a></li><li><a href="Core.Tools.DistanceMeasurementCreateTool.html">Core.Tools.DistanceMeasurementCreateTool</a></li><li><a href="Core.Tools.EllipseCreateTool.html">Core.Tools.EllipseCreateTool</a></li><li><a href="Core.Tools.EllipseMeasurementCreateTool.html">Core.Tools.EllipseMeasurementCreateTool</a></li><li><a href="Core.Tools.EraserTool.html">Core.Tools.EraserTool</a></li><li><a href="Core.Tools.FileAttachmentCreateTool.html">Core.Tools.FileAttachmentCreateTool</a></li><li><a href="Core.Tools.FreeHandCreateTool.html">Core.Tools.FreeHandCreateTool</a></li><li><a href="Core.Tools.FreeHandHighlightCreateTool.html">Core.Tools.FreeHandHighlightCreateTool</a></li><li><a href="Core.Tools.FreeTextCreateTool.html">Core.Tools.FreeTextCreateTool</a></li><li><a href="Core.Tools.GenericAnnotationCreateTool.html">Core.Tools.GenericAnnotationCreateTool</a></li><li><a href="Core.Tools.LineCreateTool.html">Core.Tools.LineCreateTool</a></li><li><a href="Core.Tools.ListBoxFormFieldCreateTool.html">Core.Tools.ListBoxFormFieldCreateTool</a></li><li><a href="Core.Tools.MarqueeZoomTool.html">Core.Tools.MarqueeZoomTool</a></li><li><a href="Core.Tools.PageCoordinate.html">Core.Tools.PageCoordinate</a></li><li><a href="Core.Tools.PanTool.html">Core.Tools.PanTool</a></li><li><a href="Core.Tools.PerimeterMeasurementCreateTool.html">Core.Tools.PerimeterMeasurementCreateTool</a></li><li><a href="Core.Tools.PolygonCloudCreateTool.html">Core.Tools.PolygonCloudCreateTool</a></li><li><a href="Core.Tools.PolygonCreateTool.html">Core.Tools.PolygonCreateTool</a></li><li><a href="Core.Tools.PolylineCreateTool.html">Core.Tools.PolylineCreateTool</a></li><li><a href="Core.Tools.RadioButtonFormFieldCreateTool.html">Core.Tools.RadioButtonFormFieldCreateTool</a></li><li><a href="Core.Tools.RectangleCreateTool.html">Core.Tools.RectangleCreateTool</a></li><li><a href="Core.Tools.RectangularAreaMeasurementTool.html">Core.Tools.RectangularAreaMeasurementTool</a></li><li><a href="Core.Tools.RedactionCreateTool.html">Core.Tools.RedactionCreateTool</a></li><li><a href="Core.Tools.RubberStampCreateTool.html">Core.Tools.RubberStampCreateTool</a></li><li><a href="Core.Tools.SignatureCreateTool.html">Core.Tools.SignatureCreateTool</a></li><li><a href="Core.Tools.StampCreateTool.html">Core.Tools.StampCreateTool</a></li><li><a href="Core.Tools.StickyCreateTool.html">Core.Tools.StickyCreateTool</a></li><li><a href="Core.Tools.TextAnnotationCreateTool.html">Core.Tools.TextAnnotationCreateTool</a></li><li><a href="Core.Tools.TextFormFieldCreateTool.html">Core.Tools.TextFormFieldCreateTool</a></li><li><a href="Core.Tools.TextHighlightCreateTool.html">Core.Tools.TextHighlightCreateTool</a></li><li><a href="Core.Tools.TextSelectTool.html">Core.Tools.TextSelectTool</a></li><li><a href="Core.Tools.TextSquigglyCreateTool.html">Core.Tools.TextSquigglyCreateTool</a></li><li><a href="Core.Tools.TextStrikeoutCreateTool.html">Core.Tools.TextStrikeoutCreateTool</a></li><li><a href="Core.Tools.TextTool.html">Core.Tools.TextTool</a></li><li><a href="Core.Tools.TextUnderlineCreateTool.html">Core.Tools.TextUnderlineCreateTool</a></li><li><a href="Core.Tools.Tool.html">Core.Tools.Tool</a></li><li><a href="TextHighlightAnnotation.html">TextHighlightAnnotation</a></li><li><a href="UI.Header.html">UI.Header</a></li><li><a href="UI.MentionsManager.html">UI.MentionsManager</a></li><li><a href="WebViewerInstance.html">WebViewerInstance</a></li>
</ul>
</li>
<li class="dropdown">
<a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="Core.AnnotationHistoryManager.html#event:historyChanged">Core.AnnotationHistoryManager#event:historyChanged</a></li><li><a href="Core.AnnotationManager.html#event:addReply">Core.AnnotationManager#event:addReply</a></li><li><a href="Core.AnnotationManager.html#event:annotationChanged">Core.AnnotationManager#event:annotationChanged</a></li><li><a href="Core.AnnotationManager.html#event:annotationDeselected">Core.AnnotationManager#event:annotationDeselected</a></li><li><a href="Core.AnnotationManager.html#event:annotationDoubleClicked">Core.AnnotationManager#event:annotationDoubleClicked</a></li><li><a href="Core.AnnotationManager.html#event:annotationHidden">Core.AnnotationManager#event:annotationHidden</a></li><li><a href="Core.AnnotationManager.html#event:annotationsDrawn">Core.AnnotationManager#event:annotationsDrawn</a></li><li><a href="Core.AnnotationManager.html#event:annotationSelected">Core.AnnotationManager#event:annotationSelected</a></li><li><a href="Core.AnnotationManager.html#event:deleteReply">Core.AnnotationManager#event:deleteReply</a></li><li><a href="Core.AnnotationManager.html#event:fieldChanged">Core.AnnotationManager#event:fieldChanged</a></li><li><a href="Core.AnnotationManager.html#event:fileAttachmentDataAvailable">Core.AnnotationManager#event:fileAttachmentDataAvailable</a></li><li><a href="Core.AnnotationManager.html#event:setNoteText">Core.AnnotationManager#event:setNoteText</a></li><li><a href="Core.AnnotationManager.html#event:updateAnnotationPermission">Core.AnnotationManager#event:updateAnnotationPermission</a></li><li><a href="Core.Annotations.Forms.Field.html#event:calculate">Core.Annotations.Forms.Field#event:calculate</a></li><li><a href="Core.Annotations.Forms.Field.html#event:change">Core.Annotations.Forms.Field#event:change</a></li><li><a href="Core.Annotations.Forms.Field.html#event:commit">Core.Annotations.Forms.Field#event:commit</a></li><li><a href="Core.ContentEdit.html#event:editBoxesAvailable">Core.ContentEdit#event:editBoxesAvailable</a></li><li><a href="Core.ContentEdit.html#event:textContentUpdated">Core.ContentEdit#event:textContentUpdated</a></li><li><a href="Core.Document.html#event:colorSeparationAdded">Core.Document#event:colorSeparationAdded</a></li><li><a href="Core.Document.html#event:layersUpdated">Core.Document#event:layersUpdated</a></li><li><a href="Core.DocumentViewer.html#event:activeSearchResultChanged">Core.DocumentViewer#event:activeSearchResultChanged</a></li><li><a href="Core.DocumentViewer.html#event:annotationsLoaded">Core.DocumentViewer#event:annotationsLoaded</a></li><li><a href="Core.DocumentViewer.html#event:beforeDocumentLoaded">Core.DocumentViewer#event:beforeDocumentLoaded</a></li><li><a href="Core.DocumentViewer.html#event:beginRendering">Core.DocumentViewer#event:beginRendering</a></li><li><a href="Core.DocumentViewer.html#event:click">Core.DocumentViewer#event:click</a></li><li><a href="Core.DocumentViewer.html#event:dblClick">Core.DocumentViewer#event:dblClick</a></li><li><a href="Core.DocumentViewer.html#event:displayModeUpdated">Core.DocumentViewer#event:displayModeUpdated</a></li><li><a href="Core.DocumentViewer.html#event:displayPageLocation">Core.DocumentViewer#event:displayPageLocation</a></li><li><a href="Core.DocumentViewer.html#event:documentLoaded">Core.DocumentViewer#event:documentLoaded</a></li><li><a href="Core.DocumentViewer.html#event:documentUnloaded">Core.DocumentViewer#event:documentUnloaded</a></li><li><a href="Core.DocumentViewer.html#event:embeddedThumbnailComplete">Core.DocumentViewer#event:embeddedThumbnailComplete</a></li><li><a href="Core.DocumentViewer.html#event:finishedRendering">Core.DocumentViewer#event:finishedRendering</a></li><li><a href="Core.DocumentViewer.html#event:fitModeUpdated">Core.DocumentViewer#event:fitModeUpdated</a></li><li><a href="Core.DocumentViewer.html#event:keyDown">Core.DocumentViewer#event:keyDown</a></li><li><a href="Core.DocumentViewer.html#event:keyUp">Core.DocumentViewer#event:keyUp</a></li><li><a href="Core.DocumentViewer.html#event:mouseEnter">Core.DocumentViewer#event:mouseEnter</a></li><li><a href="Core.DocumentViewer.html#event:mouseLeave">Core.DocumentViewer#event:mouseLeave</a></li><li><a href="Core.DocumentViewer.html#event:mouseLeftDown">Core.DocumentViewer#event:mouseLeftDown</a></li><li><a href="Core.DocumentViewer.html#event:mouseLeftUp">Core.DocumentViewer#event:mouseLeftUp</a></li><li><a href="Core.DocumentViewer.html#event:mouseMove">Core.DocumentViewer#event:mouseMove</a></li><li><a href="Core.DocumentViewer.html#event:mouseRightDown">Core.DocumentViewer#event:mouseRightDown</a></li><li><a href="Core.DocumentViewer.html#event:mouseRightUp">Core.DocumentViewer#event:mouseRightUp</a></li><li><a href="Core.DocumentViewer.html#event:notify">Core.DocumentViewer#event:notify</a></li><li><a href="Core.DocumentViewer.html#event:pageComplete">Core.DocumentViewer#event:pageComplete</a></li><li><a href="Core.DocumentViewer.html#event:pageNumberUpdated">Core.DocumentViewer#event:pageNumberUpdated</a></li><li><a href="Core.DocumentViewer.html#event:pagesUpdated">Core.DocumentViewer#event:pagesUpdated</a></li><li><a href="Core.DocumentViewer.html#event:rotationUpdated">Core.DocumentViewer#event:rotationUpdated</a></li><li><a href="Core.DocumentViewer.html#event:searchInProgress">Core.DocumentViewer#event:searchInProgress</a></li><li><a href="Core.DocumentViewer.html#event:searchResultsChanged">Core.DocumentViewer#event:searchResultsChanged</a></li><li><a href="Core.DocumentViewer.html#event:tap">Core.DocumentViewer#event:tap</a></li><li><a href="Core.DocumentViewer.html#event:textSelected">Core.DocumentViewer#event:textSelected</a></li><li><a href="Core.DocumentViewer.html#event:toolModeUpdated">Core.DocumentViewer#event:toolModeUpdated</a></li><li><a href="Core.DocumentViewer.html#event:toolUpdated">Core.DocumentViewer#event:toolUpdated</a></li><li><a href="Core.DocumentViewer.html#event:zoomUpdated">Core.DocumentViewer#event:zoomUpdated</a></li><li><a href="Core.EditBoxManager.html#event:editorBlur">Core.EditBoxManager#event:editorBlur</a></li><li><a href="Core.EditBoxManager.html#event:editorFocus">Core.EditBoxManager#event:editorFocus</a></li><li><a href="Core.EditBoxManager.html#event:editorSelectionChanged">Core.EditBoxManager#event:editorSelectionChanged</a></li><li><a href="Core.EditBoxManager.html#event:editorTextChanged">Core.EditBoxManager#event:editorTextChanged</a></li><li><a href="Core.MeasurementManager.html#event:scaleUpdated">Core.MeasurementManager#event:scaleUpdated</a></li><li><a href="Core.Tools.ArcCreateTool.html#event:annotationAdded">Core.Tools.ArcCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.ArcCreateTool.html#event:annotationCreated">Core.Tools.ArcCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.ArcMeasurementCreateTool.html#event:annotationAdded">Core.Tools.ArcMeasurementCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.ArcMeasurementCreateTool.html#event:annotationCreated">Core.Tools.ArcMeasurementCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.AreaMeasurementCreateTool.html#event:annotationAdded">Core.Tools.AreaMeasurementCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.AreaMeasurementCreateTool.html#event:annotationCreated">Core.Tools.AreaMeasurementCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.ArrowCreateTool.html#event:annotationAdded">Core.Tools.ArrowCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.ArrowCreateTool.html#event:annotationCreated">Core.Tools.ArrowCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.CalloutCreateTool.html#event:annotationAdded">Core.Tools.CalloutCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.CalloutCreateTool.html#event:annotationCreated">Core.Tools.CalloutCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.ChangeViewCreateTool.html#event:annotationAdded">Core.Tools.ChangeViewCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.ChangeViewCreateTool.html#event:annotationCreated">Core.Tools.ChangeViewCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.CheckBoxFormFieldCreateTool.html#event:annotationAdded">Core.Tools.CheckBoxFormFieldCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.CheckBoxFormFieldCreateTool.html#event:annotationCreated">Core.Tools.CheckBoxFormFieldCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.CloudyRectangularAreaMeasurementTool.html#event:annotationAdded">Core.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAdded</a></li><li><a href="Core.Tools.CloudyRectangularAreaMeasurementTool.html#event:annotationCreated">Core.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreated</a></li><li><a href="Core.Tools.ComboBoxFormFieldCreateTool.html#event:annotationAdded">Core.Tools.ComboBoxFormFieldCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.ComboBoxFormFieldCreateTool.html#event:annotationCreated">Core.Tools.ComboBoxFormFieldCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.CountMeasurementCreateTool.html#event:annotationAdded">Core.Tools.CountMeasurementCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.CountMeasurementCreateTool.html#event:annotationCreated">Core.Tools.CountMeasurementCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.CropCreateTool.html#event:cropApplied">Core.Tools.CropCreateTool#event:cropApplied</a></li><li><a href="Core.Tools.DateFreeTextCreateTool.html#event:annotationAdded">Core.Tools.DateFreeTextCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.DateFreeTextCreateTool.html#event:annotationCreated">Core.Tools.DateFreeTextCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.DistanceMeasurementCreateTool.html#event:annotationAdded">Core.Tools.DistanceMeasurementCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.DistanceMeasurementCreateTool.html#event:annotationCreated">Core.Tools.DistanceMeasurementCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.EllipseCreateTool.html#event:annotationAdded">Core.Tools.EllipseCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.EllipseCreateTool.html#event:annotationCreated">Core.Tools.EllipseCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.EllipseMeasurementCreateTool.html#event:annotationAdded">Core.Tools.EllipseMeasurementCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.EllipseMeasurementCreateTool.html#event:annotationCreated">Core.Tools.EllipseMeasurementCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.EraserTool.html#event:annotationAdded">Core.Tools.EraserTool#event:annotationAdded</a></li><li><a href="Core.Tools.EraserTool.html#event:annotationCreated">Core.Tools.EraserTool#event:annotationCreated</a></li><li><a href="Core.Tools.EraserTool.html#event:erasingAnnotation">Core.Tools.EraserTool#event:erasingAnnotation</a></li><li><a href="Core.Tools.FreeHandCreateTool.html#event:annotationAdded">Core.Tools.FreeHandCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.FreeHandCreateTool.html#event:annotationCreated">Core.Tools.FreeHandCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.FreeHandHighlightCreateTool.html#event:annotationAdded">Core.Tools.FreeHandHighlightCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.FreeHandHighlightCreateTool.html#event:annotationCreated">Core.Tools.FreeHandHighlightCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.FreeTextCreateTool.html#event:annotationAdded">Core.Tools.FreeTextCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.FreeTextCreateTool.html#event:annotationCreated">Core.Tools.FreeTextCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.GenericAnnotationCreateTool.html#event:annotationAdded">Core.Tools.GenericAnnotationCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.GenericAnnotationCreateTool.html#event:annotationCreated">Core.Tools.GenericAnnotationCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.LineCreateTool.html#event:annotationAdded">Core.Tools.LineCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.LineCreateTool.html#event:annotationCreated">Core.Tools.LineCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.ListBoxFormFieldCreateTool.html#event:annotationAdded">Core.Tools.ListBoxFormFieldCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.ListBoxFormFieldCreateTool.html#event:annotationCreated">Core.Tools.ListBoxFormFieldCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.PerimeterMeasurementCreateTool.html#event:annotationAdded">Core.Tools.PerimeterMeasurementCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.PerimeterMeasurementCreateTool.html#event:annotationCreated">Core.Tools.PerimeterMeasurementCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.PolygonCloudCreateTool.html#event:annotationAdded">Core.Tools.PolygonCloudCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.PolygonCloudCreateTool.html#event:annotationCreated">Core.Tools.PolygonCloudCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.PolygonCreateTool.html#event:annotationAdded">Core.Tools.PolygonCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.PolygonCreateTool.html#event:annotationCreated">Core.Tools.PolygonCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.PolylineCreateTool.html#event:annotationAdded">Core.Tools.PolylineCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.PolylineCreateTool.html#event:annotationCreated">Core.Tools.PolylineCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.RadioButtonFormFieldCreateTool.html#event:annotationAdded">Core.Tools.RadioButtonFormFieldCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.RadioButtonFormFieldCreateTool.html#event:annotationCreated">Core.Tools.RadioButtonFormFieldCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.RectangleCreateTool.html#event:annotationAdded">Core.Tools.RectangleCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.RectangleCreateTool.html#event:annotationCreated">Core.Tools.RectangleCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.RectangularAreaMeasurementTool.html#event:annotationAdded">Core.Tools.RectangularAreaMeasurementTool#event:annotationAdded</a></li><li><a href="Core.Tools.RectangularAreaMeasurementTool.html#event:annotationCreated">Core.Tools.RectangularAreaMeasurementTool#event:annotationCreated</a></li><li><a href="Core.Tools.RedactionCreateTool.html#event:annotationAdded">Core.Tools.RedactionCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.RedactionCreateTool.html#event:annotationCreated">Core.Tools.RedactionCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.RubberStampCreateTool.html#event:annotationAdded">Core.Tools.RubberStampCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.SignatureCreateTool.html#event:annotationAdded">Core.Tools.SignatureCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.SignatureCreateTool.html#event:fileRejected">Core.Tools.SignatureCreateTool#event:fileRejected</a></li><li><a href="Core.Tools.SignatureCreateTool.html#event:locationSelected">Core.Tools.SignatureCreateTool#event:locationSelected</a></li><li><a href="Core.Tools.SignatureCreateTool.html#event:signatureDeleted">Core.Tools.SignatureCreateTool#event:signatureDeleted</a></li><li><a href="Core.Tools.SignatureCreateTool.html#event:signatureSaved">Core.Tools.SignatureCreateTool#event:signatureSaved</a></li><li><a href="Core.Tools.StampCreateTool.html#event:annotationAdded">Core.Tools.StampCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.StampCreateTool.html#event:fileRejected">Core.Tools.StampCreateTool#event:fileRejected</a></li><li><a href="Core.Tools.StickyCreateTool.html#event:annotationAdded">Core.Tools.StickyCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.StickyCreateTool.html#event:annotationCreated">Core.Tools.StickyCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.TextAnnotationCreateTool.html#event:annotationAdded">Core.Tools.TextAnnotationCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.TextAnnotationCreateTool.html#event:annotationCreated">Core.Tools.TextAnnotationCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.TextFormFieldCreateTool.html#event:annotationAdded">Core.Tools.TextFormFieldCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.TextFormFieldCreateTool.html#event:annotationCreated">Core.Tools.TextFormFieldCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.TextHighlightCreateTool.html#event:annotationAdded">Core.Tools.TextHighlightCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.TextHighlightCreateTool.html#event:annotationCreated">Core.Tools.TextHighlightCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.TextSelectTool.html#event:selectionComplete">Core.Tools.TextSelectTool#event:selectionComplete</a></li><li><a href="Core.Tools.TextSquigglyCreateTool.html#event:annotationAdded">Core.Tools.TextSquigglyCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.TextSquigglyCreateTool.html#event:annotationCreated">Core.Tools.TextSquigglyCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.TextStrikeoutCreateTool.html#event:annotationAdded">Core.Tools.TextStrikeoutCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.TextStrikeoutCreateTool.html#event:annotationCreated">Core.Tools.TextStrikeoutCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.TextUnderlineCreateTool.html#event:annotationAdded">Core.Tools.TextUnderlineCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.TextUnderlineCreateTool.html#event:annotationCreated">Core.Tools.TextUnderlineCreateTool#event:annotationCreated</a></li><li><a href="UI.MentionsManager.html#event:mentionChanged">UI.MentionsManager#event:mentionChanged</a></li><li><a href="UI.html#event:annotationFilterChanged">UI#event:annotationFilterChanged</a></li><li><a href="UI.html#event:beforeTabChanged">UI#event:beforeTabChanged</a></li><li><a href="UI.html#event:documentLoaded">UI#event:documentLoaded</a></li><li><a href="UI.html#event:documentMerged">UI#event:documentMerged</a></li><li><a href="UI.html#event:dragOutline">UI#event:dragOutline</a></li><li><a href="UI.html#event:fileDownloaded">UI#event:fileDownloaded</a></li><li><a href="UI.html#event:finishedSavingPDF">UI#event:finishedSavingPDF</a></li><li><a href="UI.html#event:fullscreenModeToggled">UI#event:fullscreenModeToggled</a></li><li><a href="UI.html#event:loaderror">UI#event:loaderror</a></li><li><a href="UI.html#event:outlineBookmarksChanged">UI#event:outlineBookmarksChanged</a></li><li><a href="UI.html#event:panelResized">UI#event:panelResized</a></li><li><a href="UI.html#event:selectedThumbnailChanged">UI#event:selectedThumbnailChanged</a></li><li><a href="UI.html#event:tabAdded">UI#event:tabAdded</a></li><li><a href="UI.html#event:tabDeleted">UI#event:tabDeleted</a></li><li><a href="UI.html#event:tabMoved">UI#event:tabMoved</a></li><li><a href="UI.html#event:themeChanged">UI#event:themeChanged</a></li><li><a href="UI.html#event:thumbnailDragged">UI#event:thumbnailDragged</a></li><li><a href="UI.html#event:thumbnailDropped">UI#event:thumbnailDropped</a></li><li><a href="UI.html#event:toolbarGroupChanged">UI#event:toolbarGroupChanged</a></li><li><a href="UI.html#event:userBookmarksChanged">UI#event:userBookmarksChanged</a></li><li><a href="UI.html#event:viewerLoaded">UI#event:viewerLoaded</a></li><li><a href="UI.html#event:visibilityChanged">UI#event:visibilityChanged</a></li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="global.html#getInstance">getInstance</a></li><li><a href="global.html#WebViewer">WebViewer</a></li>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-8">
<div id="main">
<h1 class="page-title">Class: DocumentViewer</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="Core.html">Core</a>.</span>
DocumentViewer
</h2>
<div class="class-description">Represents a full-featured control used for displaying a Document. The viewer supports text selection and text search, and several page view modes.</div>
</header>
<article>
<div class="container-overview">
<hr>
<dt>
<h4 class="name" id="DocumentViewer"><span class="type-signature"></span>new DocumentViewer()</h4>
</dt>
<dd>
<div class="description">
Creates a new empty DocumentViewer.
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>defaults</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Default values for document viewer. Set FitMode, DisplayMode or Zoom.</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="Core.EventHandler.html">Core.EventHandler</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<dl>
<hr>
<dt class="name" id=".Events">
<h4 id=".Events"><span class="type-signature"><static> </span>Events</h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ACTIVE_SEARCH_RESULT_CHANGED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:activeSearchResultChanged">Core.DocumentViewer.activeSearchResultChanged </a></td>
</tr>
<tr>
<td class="name"><code>MOUSE_LEFT_UP</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:mouseLeftUp">Core.DocumentViewer.mouseLeftUp </a></td>
</tr>
<tr>
<td class="name"><code>MOUSE_LEFT_DOWN</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:mouseLeftDown">Core.DocumentViewer.mouseLeftDown </a></td>
</tr>
<tr>
<td class="name"><code>CLICK</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:click">Core.DocumentViewer.click </a></td>
</tr>
<tr>
<td class="name"><code>TAP</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:tap">Core.DocumentViewer.tap </a></td>
</tr>
<tr>
<td class="name"><code>DBL_CLICK</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:dblClick">Core.DocumentViewer.dblClick </a></td>
</tr>
<tr>
<td class="name"><code>KEY_DOWN</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:keyDown">Core.DocumentViewer.keyDown </a></td>
</tr>
<tr>
<td class="name"><code>KEY_UP</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:keyUp">Core.DocumentViewer.keyUp </a></td>
</tr>
<tr>
<td class="name"><code>MOUSE_ENTER</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:mouseEnter">Core.DocumentViewer.mouseEnter </a></td>
</tr>
<tr>
<td class="name"><code>MOUSE_MOVE</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:mouseMove">Core.DocumentViewer.mouseMove </a></td>
</tr>
<tr>
<td class="name"><code>MOUSE_LEAVE</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:mouseLeave">Core.DocumentViewer.mouseLeave </a></td>
</tr>
<tr>
<td class="name"><code>MOUSE_RIGHT_DOWN</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:mouseRightDown">Core.DocumentViewer.mouseRightDown </a></td>
</tr>
<tr>
<td class="name"><code>MOUSE_RIGHT_UP</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:mouseRightUp">Core.DocumentViewer.mouseRightUp </a></td>
</tr>
<tr>
<td class="name"><code>DOCUMENT_UNLOADED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:documentUnloaded">Core.DocumentViewer.documentUnloaded </a></td>
</tr>
<tr>
<td class="name"><code>ANNOTATIONS_LOADED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:annotationsLoaded">Core.DocumentViewer.annotationsLoaded </a></td>
</tr>
<tr>
<td class="name"><code>BEFORE_DOCUMENT_LOADED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:beforeDocumentLoaded">Core.DocumentViewer.beforeDocumentLoaded </a></td>
</tr>
<tr>
<td class="name"><code>DOCUMENT_LOADED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:documentLoaded">Core.DocumentViewer.documentLoaded </a></td>
</tr>
<tr>
<td class="name"><code>DISPLAY_PAGE_LOCATION</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:displayPageLocation">Core.DocumentViewer.displayPageLocation </a></td>
</tr>
<tr>
<td class="name"><code>NOTIFY</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:notify">Core.DocumentViewer#event:notify </a></td>
</tr>
<tr>
<td class="name"><code>SEARCH_IN_PROGRESS</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:searchInProgress">Core.DocumentViewer.searchInProgress </a></td>
</tr>
<tr>
<td class="name"><code>TEXT_SELECTED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:textSelected">Core.DocumentViewer.textSelected </a></td>
</tr>
<tr>
<td class="name"><code>TOOL_MODE_UPDATED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:toolModeUpdated">Core.DocumentViewer.toolModeUpdated </a></td>
</tr>
<tr>
<td class="name"><code>FIT_MODE_UPDATED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:fitModeUpdated">Core.DocumentViewer.fitModeUpdated </a></td>
</tr>
<tr>
<td class="name"><code>ROTATION_UPDATED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:rotationUpdated">Core.DocumentViewer.rotationUpdated </a></td>
</tr>
<tr>
<td class="name"><code>ZOOM_UPDATED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:zoomUpdated">Core.DocumentViewer.zoomUpdated </a></td>
</tr>
<tr>
<td class="name"><code>PAGE_NUMBER_UPDATED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:pageNumberUpdated">Core.DocumentViewer.pageNumberUpdated </a></td>
</tr>
<tr>
<td class="name"><code>PAGES_UPDATED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:pagesUpdated">Core.DocumentViewer.pagesUpdated </a></td>
</tr>
<tr>
<td class="name"><code>PAGE_COMPLETE</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:pageComplete">Core.DocumentViewer.pageComplete </a></td>
</tr>
<tr>
<td class="name"><code>DISPLAY_MODE_UPDATED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:displayModeUpdated">Core.DocumentViewer.displayModeUpdated </a></td>
</tr>
<tr>
<td class="name"><code>BEGIN_RENDERING</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:beginRendering">Core.DocumentViewer.beginRendering </a></td>
</tr>
<tr>
<td class="name"><code>FINISHED_RENDERING</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:finishedRendering">Core.DocumentViewer.finishedRendering </a></td>
</tr>
<tr>
<td class="name"><code>TOOL_UPDATED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.DocumentViewer.html#event:toolUpdated">Core.DocumentViewer.toolUpdated </a></td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".FitMode">
<h4 id=".FitMode"><span class="type-signature"><static> </span>FitMode</h4>
</dt>
<dd>
<div class="description">
Contains a list of available fit modes for the DocumentViewer.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">function</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>FitWidth</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Zoom level is constrained such that the current page's width will exactly fill the available space.</td>
</tr>
<tr>
<td class="name"><code>FitPage</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Zoom level is constrained such that the current page's width or height will exactly fill the available space.</td>
</tr>
<tr>
<td class="name"><code>Zoom</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Zoom level is not constrained.</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".SearchResults">
<h4 id=".SearchResults"><span class="type-signature"><static> </span>SearchResults</h4>
</dt>
<dd>
<div class="description">
The code indicating the reason that the search process concluded.
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ambientStr</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The text surrounding the result string.</td>
</tr>
<tr>
<td class="name"><code>resultStr</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The found text.</td>
</tr>
<tr>
<td class="name"><code>resultStrStart</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The index in ambient string where the result string starts.</td>
</tr>
<tr>
<td class="name"><code>resultStrEnd</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The index in ambient string where the result string end.</td>
</tr>
<tr>
<td class="name"><code>pageNum</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page number which the search was conducted on.</td>
</tr>
<tr>
<td class="name"><code>resultCode</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The reason the search completed.</td>
</tr>
<tr>
<td class="name"><code>quads</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">A list of Quads, representing the bounding box(es) of the found text. Useful for highlighting the text.</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<hr>
<dt>
<h4 class="name" id="addEventListener"><span class="type-signature"></span>addEventListener(type, fn [, options])</h4>
</dt>
<dd>
<div class="description">
Add a handler to the given event name
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The name of the event to listen to</td>
</tr>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last">The handler to be called when the event is triggered</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Optional options object for addEventListener
<h6 class="method-params-label method-subparams-label">Properties</h6>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>once</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">If true then the handler will be called only once</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
<dd class="inherited-from">
<ul class="dummy">
<li>
<a href="Core.EventHandler.html#addEventListener">Core.EventHandler#addEventListener</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns the object that 'addEventListener' is being called on
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">myObject.addEventListener('eventName', (eventParameter1, eventParameter2) => {
...
});</pre>
</dd>
<hr>
<dt>
<h4 class="name" id="clearSearchResults"><span class="type-signature"></span>clearSearchResults()</h4>
</dt>
<dd>
<div class="description">
Clears all search results from the viewer
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="clearSelection"><span class="type-signature"></span>clearSelection()</h4>
</dt>
<dd>
<div class="description">
Clears any selected text on the all pages.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="closeDocument"><span class="type-signature"></span>closeDocument()</h4>
</dt>
<dd>
<div class="description">
Reinitializes data and clears the viewer area content.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableAnnotations"><span class="type-signature"></span>disableAnnotations()</h4>
</dt>
<dd>
<div class="description">
Disable annotations. Annotations in the document will not be visible.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableArrowKeyNavigation"><span class="type-signature"></span>disableArrowKeyNavigation()</h4>
</dt>
<dd>
<div class="description">
Disable using the left/right arrow keys to switch pages.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableAutomaticLinking"><span class="type-signature"></span>disableAutomaticLinking()</h4>
</dt>
<dd>
<div class="description">
Disable automatic linking.
If disabled then any URLs detected in the document text will not automatically be linked.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableGrayscaleAnnotations"><span class="type-signature"></span>disableGrayscaleAnnotations()</h4>
</dt>
<dd>
<div class="description">
Disable viewing annotations in grayscale
</div>
<dl class="details">
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd class="yes-def tag-deprecated">
<ul class="dummy">
<li>Yes</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableGrayscaleAnnotationsMode"><span class="type-signature"></span>disableGrayscaleAnnotationsMode()</h4>
</dt>
<dd>
<div class="description">
Disable viewing annotations in grayscale
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableGrayscaleMode"><span class="type-signature"></span>disableGrayscaleMode()</h4>
</dt>
<dd>
<div class="description">
Disable viewing document in Grayscale
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableLoadingAnnotationsFromVisiblePages"><span class="type-signature"></span>disableLoadingAnnotationsFromVisiblePages()</h4>
</dt>
<dd>
<div class="description">
If loading annotations from visible pages was previously enabled then calling this function will switch back to the default behavior.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableReadOnlyMode"><span class="type-signature"></span>disableReadOnlyMode()</h4>
</dt>
<dd>
<div class="description">
Disables read-only mode in the viewer.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableRightToLeftPageRendering"><span class="type-signature"></span>disableRightToLeftPageRendering()</h4>
</dt>
<dd>
<div class="description">
Disable right to left page rendering order.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableStylusMode"><span class="type-signature"></span>disableStylusMode()</h4>
</dt>
<dd>
<div class="description">
Disables the stylus annotating mode for all annotation tools.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableViewportRenderMode"><span class="type-signature"></span>disableViewportRenderMode()</h4>
</dt>
<dd>
<div class="description">
Disables viewport rendering mode
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="displayAdditionalSearchResult"><span class="type-signature"></span>displayAdditionalSearchResult(result)</h4>
</dt>
<dd>
<div class="description">
Displays the new search result without clearing previous results
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The result of a search, Core.DocumentViewer.SearchResult Returned by onResult in <a href="Core.DocumentViewer.html#textSearchInit">Core.DocumentViewer#textSearchInit</a>.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="displayAdditionalSearchResults"><span class="type-signature"></span>displayAdditionalSearchResults(results)</h4>
</dt>
<dd>
<div class="description">
Displays the new search results without clearing previous results
If you need to display many results at the same time this can be much
more efficient than calling displayAdditionalSearchResult for each result
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>results</code></td>
<td class="type">
<span class="param-type">Array.<object></span>
</td>
<td class="description last">An array of search results Core.DocumentViewer.SearchResult. Returned by onResult in <a href="Core.DocumentViewer.html#textSearchInit">Core.DocumentViewer#textSearchInit</a>.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="displayBookmark"><span class="type-signature"></span>displayBookmark(bookmark)</h4>
</dt>
<dd>
<div class="description">
If the boomark is an internal link then it scrolls the viewer so that the position of the bookmark is in the upper-left corner of the viewer.
If it's an external URL then it opens the URL.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>bookmark</code></td>
<td class="type">
<span class="param-type">Bookmark</span>
</td>
<td class="description last">A bookmark that specifies the location to go to. Returned by <a href="Core.Document.html#getBookmarks">Core.Document#getBookmarks</a>.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="displayFirstPage"><span class="type-signature"></span>displayFirstPage()</h4>
</dt>
<dd>
<div class="description">
Scrolls the viewer so that the upper-left corner of the Document's first page is in the upper-left corner of the viewer.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="displayLastPage"><span class="type-signature"></span>displayLastPage()</h4>
</dt>
<dd>
<div class="description">
Scrolls the viewer so that the upper-left corner of the Document's last page is in the upper-left corner of the viewer.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="displayPageLocation"><span class="type-signature"></span>displayPageLocation(pageNumber, horizontalPosition, verticalPostion [, doNotJumpIfInView])</h4>
</dt>
<dd>
<div class="description">
Shifts the current viewport of the viewer such that it can display the specified viewer coordinate position
Please refer to https://www.pdftron.com/documentation/web/guides/coordinates/#viewer-page-coordinates for more details
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The page number the location is on</td>
</tr>
<tr>
<td class="name"><code>horizontalPosition</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The horizontal position from the x-axis origin of the page (in viewer page coordinates)</td>
</tr>
<tr>
<td class="name"><code>verticalPostion</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The vertical position from the y-axis of the page (in viewer page coordinates)</td>
</tr>
<tr>
<td class="name"><code>doNotJumpIfInView</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If true then if the page location is currently in view don't cause the viewer to shift</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="displaySearchResult"><span class="type-signature"></span>displaySearchResult(result [, jump])</h4>
</dt>
<dd>
<div class="description">
Scrolls the viewer so that the position of the search result is in the middle of the viewer.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="description last">The result of a search, Core.DocumentViewer.SearchResult. Returned by onResult in <a href="Core.DocumentViewer.html#textSearchInit">Core.DocumentViewer#textSearchInit</a>.</td>
</tr>
<tr>
<td class="name"><code>jump</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The callback for navigating to the found result. This is optional and will jump to the correct location in the DocumentViewer if no parameter is passed.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="dispose"><span class="type-signature"></span>dispose()</h4>
</dt>
<dd>
<div class="description">
Disposes the current document's data
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="drawSelection"><span class="type-signature"></span>drawSelection(pageNumber)</h4>
</dt>
<dd>
<div class="description">
Draws the text selection for the specified page. Should be called after calling
AnnotationManager's drawAnnotations function if the selection should still be shown.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page number to draw the selection on</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="enableAnnotations"><span class="type-signature"></span>enableAnnotations()</h4>
</dt>
<dd>
<div class="description">
Enable annotations. Any annotations in the document will be visible.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="enableArrowKeyNavigation"><span class="type-signature"></span>enableArrowKeyNavigation()</h4>
</dt>
<dd>
<div class="description">
Enable using the left/right arrow keys to switch pages.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="enableAutomaticLinking"><span class="type-signature"></span>enableAutomaticLinking()</h4>
</dt>
<dd>
<div class="description">
Enable automatic linking.
If enabled then any URLs detected in the document text will automatically be linked.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="enableGrayscaleAnnotations"><span class="type-signature"></span>enableGrayscaleAnnotations()</h4>
</dt>
<dd>
<div class="description">
Enable viewing annotations in grayscale
</div>
<dl class="details">
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd class="yes-def tag-deprecated">
<ul class="dummy">
<li>Yes</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="enableGrayscaleAnnotationsMode"><span class="type-signature"></span>enableGrayscaleAnnotationsMode()</h4>
</dt>
<dd>
<div class="description">
Enable viewing annotations in grayscale
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="enableGrayscaleMode"><span class="type-signature"></span>enableGrayscaleMode()</h4>
</dt>
<dd>
<div class="description">
Enable viewing document in Grayscale
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="enableLoadingAnnotationsFromVisiblePages"><span class="type-signature"></span>enableLoadingAnnotationsFromVisiblePages()</h4>
</dt>
<dd>
<div class="description">
Enable annotations to only be loaded from the visible pages and removed when a page is no longer visible.
Note that when enabling this option only annotations on the visible pages will be exported or included in the downloaded document
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="enableReadOnlyMode"><span class="type-signature"></span>enableReadOnlyMode()</h4>
</dt>
<dd>
<div class="description">
Enables read-only mode in the viewer. In this mode no page manipulation features can be done from thumbnail panel of UI.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="enableRightToLeftPageRendering"><span class="type-signature"></span>enableRightToLeftPageRendering()</h4>
</dt>
<dd>
<div class="description">
Enable the right to left page rendering order.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="enableStylusMode"><span class="type-signature"></span>enableStylusMode()</h4>
</dt>
<dd>
<div class="description">
Puts all annotation tools in the stylus annotating mode.
When in this mode, finger movements will scroll the document and using a stylus device will annotate the document.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="enableViewportRenderMode"><span class="type-signature"></span>enableViewportRenderMode()</h4>
</dt>
<dd>
<div class="description">
Enables viewport rendering mode. This only renders the part of the page that is visible within the viewport.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getActiveSearchResult"><span class="type-signature"></span>getActiveSearchResult()</h4>
</dt>
<dd>
<div class="description">
Gets the currently active search result
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
SearchResult Core.DocumentViewer.SearchResult
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getAnnotationHistoryManager"><span class="type-signature"></span>getAnnotationHistoryManager()</h4>
</dt>
<dd>
<div class="description">
Returns the AnnotationHistoryManager used by this DocumentViewer
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
an instance of AnnotationHistoryManager
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">AnnotationHistoryManager</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getAnnotationManager"><span class="type-signature"></span>getAnnotationManager()</h4>
</dt>
<dd>
<div class="description">
Returns the AnnotationManager used by this DocumentViewer
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
an instance of AnnotationManager
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">AnnotationManager</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getAnnotationsLoadedPromise"><span class="type-signature"></span>getAnnotationsLoadedPromise()</h4>
</dt>
<dd>
<div class="description">
Gets a promise that resolves when the annotations in the current document have all been loaded
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Promise that resolves when the annotations in the current document have loaded.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<any></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getColorSeparationsAtPoint"><span class="type-signature"></span>getColorSeparationsAtPoint(pageNumber, x, y)</h4>
</dt>
<dd>
<div class="description">
Gets the color separation values for the specified point. The x and y values should be in page coordinates.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page number of the point</td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The x value of the point</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The y value of the point</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A list of objects which each have the name of the separation and the saturation percentage of the color at the point [{ name, value }, ...]
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<any></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getCompleteRotation"><span class="type-signature"></span>getCompleteRotation(pageNumber)</h4>
</dt>
<dd>
<div class="description">
Returns the complete rotation of the page including the document's rotation.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page number to get that page's rotation</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The current complete rotation.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.html#.PageRotation">Core.PageRotation</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getCurrentPage"><span class="type-signature"></span>getCurrentPage()</h4>
</dt>
<dd>
<div class="description">
Returns the current page number.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The current 1-indexed page number.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getDisplayModeManager"><span class="type-signature"></span>getDisplayModeManager()</h4>
</dt>
<dd>
<div class="description">
Returns the DisplayModeManager used by this DocumentViewer
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
an instance of DisplayModeManager
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">DisplayModeManager</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getDocument"><span class="type-signature"></span>getDocument()</h4>
</dt>
<dd>
<div class="description">
Returns the Document that is currently being displayed by the viewer.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
returns the current document.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.Document.html">Core.Document</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getExactViewportRegionRect"><span class="type-signature"></span>getExactViewportRegionRect(pageNumber)</h4>
</dt>
<dd>
<div class="description">
Returns the exact viewport rendering region if viewport rendering is enabled.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page number</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
returns the current viewport rendering region
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getFitMode"><span class="type-signature"></span>getFitMode()</h4>
</dt>
<dd>
<div class="description">
Returns the current fit mode.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The current fit mode.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.DocumentViewer.html#.FitMode">Core.DocumentViewer.FitMode</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getMargin"><span class="type-signature"></span>getMargin()</h4>
</dt>
<dd>
<div class="description">
Returns a pixel value, representing the left, right, top and bottom margins.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The margin value.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getMeasurementManager"><span class="type-signature"></span>getMeasurementManager()</h4>
</dt>
<dd>
<div class="description">
Returns the MeasurementManager used by this DocumentViewer
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
an instance of MeasurementManager
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">MeasurementManager</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getPageCount"><span class="type-signature"></span>getPageCount()</h4>
</dt>
<dd>
<div class="description">
Returns the number of pages in a document.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The number of the pages in the current document.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getPageHeight"><span class="type-signature"></span>getPageHeight(pageNumber)</h4>
</dt>
<dd>
<div class="description">
Get the current height of the specified page, taking into account rotation.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page number</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The height of the page
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getPageRotations"><span class="type-signature"></span>getPageRotations()</h4>
</dt>
<dd>
<div class="description">
Gets the individual page rotations of the document. Only returns pages that have been rotated individually.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
An object with keys that are page indexes (1-indexed) and values that are rotation values.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getPageSearchResults"><span class="type-signature"></span>getPageSearchResults( [pageNumber])</h4>
</dt>
<dd>
<div class="description">
Get results of the current search
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">page number indicating to return the search hits from a specific page. If it's not given, the function will return search hits from all document pages.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
SearchResult array Core.DocumentViewer.SearchResult
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getPageWidth"><span class="type-signature"></span>getPageWidth(pageNumber)</h4>
</dt>
<dd>
<div class="description">
Get the current width of the specified page, taking into account rotation.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page number</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The width of the page
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getPageZoom"><span class="type-signature"></span>getPageZoom(pageNumber)</h4>
</dt>
<dd>
<div class="description">
Get the zoom value for a particular page.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page number.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns page's zoom value
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getPDFCoordinatesFromMouseEvent"><span class="type-signature"></span>getPDFCoordinatesFromMouseEvent(event)</h4>
</dt>
<dd>
<div class="description">
Get the PDF coordinates of the current mouse event
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">MouseEvent</span>
</td>
<td class="description last">A DOM mouse event.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns an object with the x and y PDF coordinates of the mouse event
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getRightToLeftPages"><span class="type-signature"></span>getRightToLeftPages()</h4>
</dt>
<dd>
<div class="description">
Returns whether right to left page rendering is enabled.
</div>
<dl class="details">
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>Since version 8.0. Use <a href="Core.DocumentViewer.html#isRightToLeftPageRenderingEnabled">isRightToLeftPageRenderingEnabled</a> instead.</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The current page rendering order.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getRotation"><span class="type-signature"></span>getRotation( [pageNumber])</h4>
</dt>
<dd>
<div class="description">
Returns the current viewing rotation.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Optionally pass the page number to get the specific page's rotation</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The current viewing rotation.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.html#.PageRotation">Core.PageRotation</a></span>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">PageRotation['E_0'] = 0 (0 degress) <br/>
PageRotation['E_90'] = 1 (90 degress) <br/>
PageRotation['E_180'] = 2 (180 degress) <br/>
PageRotation['E_270'] = 3 (270 degress) <br/></pre>
</dd>
<hr>
<dt>
<h4 class="name" id="getScrollViewElement"><span class="type-signature"></span>getScrollViewElement()</h4>
</dt>
<dd>
<div class="description">
Gets the scrollview element that is being used by DocumentViewer
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The scrollview DOM element that DocumentViewer appends pages
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Element</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getSelectedText"><span class="type-signature"></span>getSelectedText( [pageNumber])</h4>
</dt>
<dd>
<div class="description">
Returns the text selected by text selection tool or search.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Optionally pass the 1-indexed page number</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Selected text.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getSelectedTextQuads"><span class="type-signature"></span>getSelectedTextQuads( [pageNumber])</h4>
</dt>
<dd>
<div class="description">
Returns the quads of the text selected by text selection tool or search.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Optionally pass the 1-indexed page number</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Selected text quads.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getTool"><span class="type-signature"></span>getTool(Name)</h4>
</dt>
<dd>
<div class="description">
Returns a specific tool from the tool mode map.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Name</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type"><a href="Core.Tools.html#.ToolNames">Core.Tools.ToolNames</a></span>
</td>
<td class="description last">of the tool. eg 'AnnotationEdit'</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The tool mode map object.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.Tools.Tool.html">Core.Tools.Tool</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getToolMode"><span class="type-signature"></span>getToolMode()</h4>
</dt>
<dd>
<div class="description">
Returns the current tool.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The current tool.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.Tools.Tool.html">Core.Tools.Tool</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getToolModeMap"><span class="type-signature"></span>getToolModeMap()</h4>
</dt>
<dd>
<div class="description">
Returns the tool mode map object.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The tool mode map object.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getViewerCoordinatesFromMouseEvent"><span class="type-signature"></span>getViewerCoordinatesFromMouseEvent(event)</h4>
</dt>
<dd>
<div class="description">
Get the viewer page coordinates of the current mouse event
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">MouseEvent</span>
</td>
<td class="description last">A DOM mouse event.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns an object with the x and y viewer coordinates of the mouse event
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getViewerElement"><span class="type-signature"></span>getViewerElement()</h4>
</dt>
<dd>
<div class="description">
Gets the viewer element that is being used by DocumentViewer
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The viewer DOM element that DocumentViewer appends pages
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Element</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getViewportRegionRect"><span class="type-signature"></span>getViewportRegionRect(pageNumber)</h4>
</dt>
<dd>
<div class="description">
Returns the current viewport rendering region if viewport rendering is enabled.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page number</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
returns the current viewport rendering region
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getWatermark"><span class="type-signature"></span>getWatermark()</h4>
</dt>
<dd>
<div class="description">
Gets the watermark options that had been previously set.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns a promise containing the watermark options.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<object></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getZoom"><span class="type-signature"></span>getZoom()</h4>
</dt>
<dd>
<div class="description">
Returns the current zoom level
</div>
<dl class="details">
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>Since version 8.3. Use <a href="Core.DocumentViewer.html#getZoomLevel">getZoomLevel</a> instead.</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The current zoom level.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getZoomLevel"><span class="type-signature"></span>getZoomLevel()</h4>
</dt>
<dd>
<div class="description">
Returns the current zoom level.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The current zoom level.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="isAutomaticLinkingEnabled"><span class="type-signature"></span>isAutomaticLinkingEnabled()</h4>
</dt>
<dd>
<div class="description">
Returns whether add automatic link is enabled.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Whether add automatic link is enabled.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="isGrayscaleAnnotationsModeEnabled"><span class="type-signature"></span>isGrayscaleAnnotationsModeEnabled()</h4>
</dt>
<dd>
<div class="description">
Returns whether grayscale annotations mode is enabled for viewing the document
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Whether grayscale annotation mode is enabled or not
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="isGrayscaleModeEnabled"><span class="type-signature"></span>isGrayscaleModeEnabled()</h4>
</dt>
<dd>
<div class="description">
Returns whether grayscale mode is enabled for viewing the document
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Whether grayscale mode is enabled or not
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="isInViewportRenderMode"><span class="type-signature"></span>isInViewportRenderMode()</h4>
</dt>
<dd>
<div class="description">
Returns a boolean to denote if viewer is in viewport rendering mode
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the boolean to denote if in viewport render mode
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="isRightToLeftPageRenderingEnabled"><span class="type-signature"></span>isRightToLeftPageRenderingEnabled()</h4>
</dt>
<dd>
<div class="description">
Returns whether right to left page rendering is enabled.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if right to left page rendering is enabled, false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="loadAsync"><span class="type-signature"></span>loadAsync(partRetriever, options)</h4>
</dt>
<dd>
<div class="description">
Initialize the viewer and load a .xod document into the viewer.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>partRetriever</code></td>
<td class="type">
<span class="param-type"><a href="Core.PartRetrievers.PartRetriever.html">Core.PartRetrievers.PartRetriever</a></span>
</td>
<td class="description last">An instance of PartRetriever.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">An object that can contain the following optional parameters
<h6 class="method-params-label method-subparams-label">Properties</h6>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The type of document being loaded. Values are xod, pdf, office, webviewerServer. Default is xod.</td>
</tr>
<tr>
<td class="name"><code>docId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An optional unique identifier for the document, used for offline mode</td>
</tr>
<tr>
<td class="name"><code>onError</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A callback of the form function(err) which will be called when a loading error occurs.</td>
</tr>
<tr>
<td class="name"><code>workerTransportPromise</code></td>
<td class="type">
<span class="param-type">Promise.<void></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Required for PDF viewing. A promise that will be resolved when a worker transport has been initialized. This can be created by calling Core.initializeWorkerTransport</td>
</tr>
<tr>
<td class="name"><code>getPassword</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An method of the form function(callback) where callback is of the form function(password). getPassword will be called when a password is required to load a PDF document and should call the callback with the retrieved password.</td>
</tr>
<tr>
<td class="name"><code>extension</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An field used to specify the type of file being read. This is only relevant for PDF viewing and at the moment only works for certain image formats and .pdf</td>
</tr>
<tr>
<td class="name"><code>licenseKey</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The license key to use. Only necessary for client side and WebViewer Server rendering.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="loadDocument"><span class="type-signature"></span>loadDocument(src [, options])</h4>
</dt>
<dd>
<div class="description">
Initialize the viewer and load the given file into the viewer.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>src</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">File</span>
|
<span class="param-type">ArrayBuffer</span>
|
<span class="param-type">Blob</span>
|
<span class="param-type"><a href="Core.Document.html">Core.Document</a></span>
|
<span class="param-type">Core.PDFNet.PDFDoc</span>
</td>
<td class="attributes">
</td>
<td class="description last">Source parameter, path/url to document or File.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type"><a href="Core.html#.CreateDocumentOptions">Core.CreateDocumentOptions</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Load document options.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A promise that resolves when the document is finished loading
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<void></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="off"><span class="type-signature"></span>off( [type] [, fn])</h4>
</dt>
<dd>
<div class="description">
Remove a handler of the given event name
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The name of the event to remove the handler of.
If type is undefined, all the handlers of the object will be removed</td>
</tr>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The handler associated with this event to be removed.
If fn is undefined, all the handlers of the given event name will be removed</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
<dd class="inherited-from">
<ul class="dummy">
<li>
<a href="Core.EventHandler.html#off">Core.EventHandler#off</a>
</li>
</ul>
</dd>
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>Since version 8.0. Use <a href="Core.EventHandler.html#removeEventListener">removeEventListener</a> instead.</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns the object that 'off' is being called on
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">myObject.off();
myObject.off('eventName');
myObject.off('eventName', fn);</pre>
</dd>
<hr>
<dt>
<h4 class="name" id="on"><span class="type-signature"></span>on(type, fn)</h4>
</dt>
<dd>
<div class="description">
Add a handler to the given event name
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">number</span>
</td>
<td class="description last">The name of the event to listen to</td>
</tr>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">The handler to be called when the event is triggered</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
<dd class="inherited-from">
<ul class="dummy">
<li>
<a href="Core.EventHandler.html#on">Core.EventHandler#on</a>
</li>
</ul>
</dd>
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>Since version 8.0. Use <a href="Core.EventHandler.html#addEventListener">addEventListener</a> instead.</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns the object that 'on' is being called on
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">myObject.on('eventName', (eventParameter1, eventParameter2) => {
...
});</pre>
</dd>
<hr>
<dt>
<h4 class="name" id="one"><span class="type-signature"></span>one(type, fn)</h4>
</dt>
<dd>
<div class="description">
Same as 'on' except the handler will be called only once
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">number</span>
</td>
<td class="description last">The name of the event to listen to</td>
</tr>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">The handler to be called when the event is triggered</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
<dd class="inherited-from">
<ul class="dummy">
<li>
<a href="Core.EventHandler.html#one">Core.EventHandler#one</a>
</li>
</ul>
</dd>
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>Since version 8.0. Use <a href="Core.EventHandler.html#addEventListener">addEventListener</a> with {'once': true} as options instead.</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns the object that 'one' is being called on
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">myObject.one('eventName', (eventParameter1, eventParameter2) => {
...
});</pre>
</dd>
<hr>
<dt>
<h4 class="name" id="recalculateLayout"><span class="type-signature"></span>recalculateLayout(pagesToRecalculate)</h4>
</dt>
<dd>
<div class="description">
Request a recalculation of page layout and rerender all pages. For use when
modifying the underlying Document without using the provided page
modification functions (cropPages, rotatePages...)
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pagesToRecalculate</code></td>
<td class="type">
<span class="param-type">Array.<number></span>
</td>
<td class="description last">An array of page numbers (1-indexed) that should be recalculated</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="refreshAll"><span class="type-signature"></span>refreshAll()</h4>
</dt>
<dd>
<div class="description">
Invalidates the rendering cache for all pages and removes embedded
thumbnails for viewer optimized PDF
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="refreshPage"><span class="type-signature"></span>refreshPage(pageNumber)</h4>
</dt>
<dd>
<div class="description">
Invalidates the rendering cache for the specified page
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page number of the page (1-indexed)</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="removeContent"><span class="type-signature"></span>removeContent(removeData, rotationChanged, isZoomChanged)</h4>
</dt>
<dd>
<div class="description">
Removes all the page content from the DOM.
Also clear the cache if the zoom or rotation has changed.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>removeData</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether or not to remove all event handlers and data on the elements</td>
</tr>
<tr>
<td class="name"><code>rotationChanged</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>isZoomChanged</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="removeEventListener"><span class="type-signature"></span>removeEventListener( [type] [, fn])</h4>
</dt>
<dd>
<div class="description">
Remove a handler of the given event name
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The name of the event to remove the handler of.
If type is undefined, all the handlers of the object will be removed</td>
</tr>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The handler associated with this event to be removed.
If fn is undefined, all the handlers of the given event name will be removed</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
<dd class="inherited-from">
<ul class="dummy">
<li>
<a href="Core.EventHandler.html#removeEventListener">Core.EventHandler#removeEventListener</a>
</li>
</ul>
</dd>
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>for version 9.0. Use [removeEventListener] with fn specified</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns the object that 'removeEventListener' is being called on
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">myObject.removeEventListener();
myObject.removeEventListener('eventName');
myObject.removeEventListener('eventName', fn);</pre>
</dd>
<hr>
<dt>
<h4 class="name" id="rotateClockwise"><span class="type-signature"></span>rotateClockwise( [pageNumber])</h4>
</dt>
<dd>
<div class="description">
Rotates all pages in the currently displayed document clockwise by 90 degrees.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Optionally pass the page number to rotate only a specific page</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="rotateCounterClockwise"><span class="type-signature"></span>rotateCounterClockwise( [pageNumber])</h4>
</dt>
<dd>
<div class="description">
Rotates all pages in the currently displayed document counter-clockwise by 90 degrees.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Optionally pass the page number to rotate only a specific page</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="scrollViewUpdated"><span class="type-signature"></span>scrollViewUpdated()</h4>
</dt>
<dd>
<div class="description">
This function must be called after modifying the scroll view element's dimensions or properties.
The scroll view is the element returned from docViewer.getScrollViewElement()
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="select"><span class="type-signature"></span>select(pt1, pt2)</h4>
</dt>
<dd>
<div class="description">
Selects the text content of the document given two page coordinates.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pt1</code></td>
<td class="type">
</td>
<td class="description last">Starting page coordinate. Requires properties x, y and pageNumber.</td>
</tr>
<tr>
<td class="name"><code>pt2</code></td>
<td class="type">
</td>
<td class="description last">Ending page coordinate. Requires properties x, y and pageNumber.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setActiveSearchResult"><span class="type-signature"></span>setActiveSearchResult(result)</h4>
</dt>
<dd>
<div class="description">
Sets the active search result, causing it to be displayed as a different color and visible on the screen.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The result of a search, Core.DocumentViewer.SearchResult. Returned by onResult in <a href="Core.DocumentViewer.html#textSearchInit">Core.DocumentViewer#textSearchInit</a>.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setAnnotationImportOptions"><span class="type-signature"></span>setAnnotationImportOptions(options)</h4>
</dt>
<dd>
<div class="description">
Set the options that are used when importing annotations from a document asynchronously.
These are the options that will be passed to AnnotationManager.importAnnotations.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The options for importing
<h6 class="method-params-label method-subparams-label">Properties</h6>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>batchSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The number of annotations to import in each batch</td>
</tr>
<tr>
<td class="name"><code>batchDelay</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The amount of time in milliseconds to delay between importing each batch</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setCurrentPage"><span class="type-signature"></span>setCurrentPage(pageNumber, isSmoothScroll)</h4>
</dt>
<dd>
<div class="description">
Sets the current page. Updates the current page and jumps to it.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page number to jump to.</td>
</tr>
<tr>
<td class="name"><code>isSmoothScroll</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">If set to true, the viewer will scroll in a smooth way.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setDefaultPageColor"><span class="type-signature"></span>setDefaultPageColor(color)</h4>
</dt>
<dd>
<div class="description">
Sets default background color for pages, default is white.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Background color value</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setDocumentXFDFRetriever"><span class="type-signature"></span>setDocumentXFDFRetriever(retriever)</h4>
</dt>
<dd>
<div class="description">
Sets the XFDF retriever that will be called when a document is being loaded. The XFDF returned from the retriever will be merged into the document.
It is recommended to use this function instead of annotManager.importAnnotations if you are loading XFDF from your server so that you don't need to wait for the annotationsLoaded event to be triggered. setDocumentXFDFRetriever will ensure that the annotation data is merged at the right time and as early as possible.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>retriever</code></td>
<td class="type">
<span class="param-type"><a href="Core.DocumentViewer.html#.DocumentXFDFRetriever">Core.DocumentViewer.DocumentXFDFRetriever</a></span>
|
<span class="param-type">null</span>
</td>
<td class="description last">A retriever function that returns a Promise which should resolve to the XFDF string that is going to merged into the document</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A promise that resolves when the retriever has been set
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<void></span>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">instance.docViewer.setDocumentXFDFRetriever(async (documentId) => {
const documentXFDFString = await fetchDocumentXFDFFromServer(documentId);
return documentXFDFString;
})</pre>
</dd>
<hr>
<dt>
<h4 class="name" id="setEnableAutomaticLinking"><span class="type-signature"></span>setEnableAutomaticLinking(enable)</h4>
</dt>
<dd>
<div class="description">
Sets whether automatic linking should be enabled.
If enabled then any URLs detected in the document text will automatically be linked.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>enable</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether to enable automatic linking.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>since version 8.0
Please use enableAutomaticLinking or disableAutomaticLinking instead</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setEnableStylusMode"><span class="type-signature"></span>setEnableStylusMode(enable)</h4>
</dt>
<dd>
<div class="description">
Sets if all the annotation tools are in the stylus annotating mode.
When in this mode, finger movements will scroll the document and using a stylus device will annotate the document.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>enable</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">a boolean indicating whether stylus annotating mode should be used</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>since version 8.0
Please use enableStylusMode or disableStylusMode instead</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setEnableStylusMode"><span class="type-signature"></span>setEnableStylusMode()</h4>
</dt>
<dd>
<div class="description">
Returns whether stylus annotating mode is enabled.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns whether stylus annotating mode is enabled
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setFitMode"><span class="type-signature"></span>setFitMode(fitMode)</h4>
</dt>
<dd>
<div class="description">
Sets how the document will scale to fit the size of the scrollviewer's viewport.
Also re-renders content to the appropriate zoom level.
Only renders if a document has been loaded.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fitMode</code></td>
<td class="type">
<span class="param-type">DocumentViewer.FitMode</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setInternalAnnotationsTransform"><span class="type-signature"></span>setInternalAnnotationsTransform(handler)</h4>
</dt>
<dd>
<div class="description">
Allows you to transform (or replace) the internal annotations of the document. Note that to handle annotations using PDFNetJS without useDownloader: false you will also want to call setPagesUpdatedInternalAnnotationsTransform
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>handler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A handler function that takes annotation data as the first parameter and a callback that is called when the transformed data is ready as the second parameter</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setLoadAnnotationsFromVisiblePages"><span class="type-signature"></span>setLoadAnnotationsFromVisiblePages(val)</h4>
</dt>
<dd>
<div class="description">
Sets whether annotations should only be loaded from the visible pages and removed when a page is no longer visible.
Note that when enabling this option only annotations on the visible pages will be exported or included in the downloaded document
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether the option should be enabled or not</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>since version 8.0
Please use enableLoadingAnnotationsFromVisiblePages or disableLoadingAnnotationsFromVisiblePages instead</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setMargin"><span class="type-signature"></span>setMargin(margin)</h4>
</dt>
<dd>
<div class="description">
Set the pixel value to use for the left, right, top and bottom margins.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>margin</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The margin value to set.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setOptions"><span class="type-signature"></span>setOptions(options)</h4>
</dt>
<dd>
<div class="description">
Sets specific DocumentViewer options.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">An options object, currently valid options are enableAnnotations and annotMode</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>Since version 8.3. Use <a href="Core.DocumentViewer.html#enableAnnotations">enableAnnotations</a> and <a href="Core.DocumentViewer.html#disableAnnotations">disableAnnotations</a> instead.</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setPageRotations"><span class="type-signature"></span>setPageRotations(rotations)</h4>
</dt>
<dd>
<div class="description">
Sets the individual page rotations of multiple pages at once. Pages that aren't specified will
use the default document rotation.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rotations</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">An object with keys that are page indexes (1-indexed) and values that are rotation values.
Rotations should be specified as {Core.PageRotation}s</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setPagesUpdatedInternalAnnotationsTransform"><span class="type-signature"></span>setPagesUpdatedInternalAnnotationsTransform(handler)</h4>
</dt>
<dd>
<div class="description">
Allows you to transform (or replace) the internal annotations of the document when pages receive an update event. This includes when using PDFNetJS with downloader enabled (default) on a linearized document. For completeness you will also want to call setInternalAnnotationsTransform.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>handler</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A handler function that takes annotation data as the first parameter, an array of updated page numbers as a second parameter and a callback that is called when the transformed data is ready as a third parameter</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setPageVisibilityCallback"><span class="type-signature"></span>setPageVisibilityCallback(callback)</h4>
</dt>
<dd>
<div class="description">
Sets the callback function that will be called when a page is newly visible in the viewer.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A function that takes in a page number indicating the page that is now visible</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setPageZoom"><span class="type-signature"></span>setPageZoom(pageNumber, zoom)</h4>
</dt>
<dd>
<div class="description">
Sets the zoom for a particular page. Should be followed by a call to updateView to actually render the page.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page number.</td>
</tr>
<tr>
<td class="name"><code>zoom</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Zoom value for page.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setRightToLeftPages"><span class="type-signature"></span>setRightToLeftPages(rightToLeftPages)</h4>
</dt>
<dd>
<div class="description">
Sets the page rendering order.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rightToLeftPages</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether the new page rendering order should be right to left or not.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>since version 8.0
Please use enableRightToLeftPageRendering or disableRightToLeftPageRendering instead</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setRotation"><span class="type-signature"></span>setRotation(pageRotation [, pageNumber])</h4>
</dt>
<dd>
<div class="description">
Sets the current viewing rotation.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageRotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.html#.PageRotation">Core.PageRotation</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">desired viewing rotation.</td>
</tr>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Optionally pass the page number to set the specific page's rotation</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setScrollViewElement"><span class="type-signature"></span>setScrollViewElement(scrollViewElement)</h4>
</dt>
<dd>
<div class="description">
Sets the scrollview element that DocumentViewer will append rendered pages to.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>scrollViewElement</code></td>
<td class="type">
<span class="param-type">Element</span>
</td>
<td class="description last">The scrollview DOM element to be used</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setSearchHighlightColors"><span class="type-signature"></span>setSearchHighlightColors(colorOptions)</h4>
</dt>
<dd>
<div class="description">
Sets the color to use when highlighting text from searching.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>colorOptions</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">An object with searchResult or activeSearchResult properties
set as a color eg 'rgba(0, 0, 200, 0.5)'</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">docViewer.setSearchHighlightColors({
searchResult: 'rgba(255, 0, 0, 0.5)',
activeSearchResult: 'rgba(0, 255, 0, 0.5)'
});</pre>
</dd>
<hr>
<dt>
<h4 class="name" id="setSearchPageBatchSize"><span class="type-signature"></span>setSearchPageBatchSize(searchBatchSize)</h4>
</dt>
<dd>
<div class="description">
[PDF Document only] Set the number of pages to search at a time. Searching more pages at a time will speed up searching but decrease page rendering responsiveness while a search is ongoing. Default is 50.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>searchBatchSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The number of pages to search at a time</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setTextHighlightColor"><span class="type-signature"></span>setTextHighlightColor(color)</h4>
</dt>
<dd>
<div class="description">
Sets the color to use when highlighting text from text selection.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The color to set. eg 'rgba(0, 0, 200, 0.3)'</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setToolMode"><span class="type-signature"></span>setToolMode(tool)</h4>
</dt>
<dd>
<div class="description">
Sets the tool mode. Also removes selection caused by text selection or search.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>tool</code></td>
<td class="type">
<span class="param-type"><a href="Core.Tools.Tool.html">Core.Tools.Tool</a></span>
</td>
<td class="description last">An instance of the toolmode</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setViewerElement"><span class="type-signature"></span>setViewerElement(viewerElement)</h4>
</dt>
<dd>
<div class="description">
Sets the viewer element that DocumentViewer will append rendered pages to.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>viewerElement</code></td>
<td class="type">
<span class="param-type">Element</span>
</td>
<td class="description last">The viewer DOM element to be used</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setViewportRenderMode"><span class="type-signature"></span>setViewportRenderMode(val)</h4>
</dt>
<dd>
<div class="description">
Sets whether viewport rendering mode should be used
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>val</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether viewport rendering mode should be used or not</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>since version 8.0
Please use enableViewportRenderMode or disableViewportRenderMode instead</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setWatermark"><span class="type-signature"></span>setWatermark(options)</h4>
</dt>
<dd>
<div class="description">
Sets watermark to be added to documents. Instead of an options object you can also pass a Promise
that resolves with the watermark options object. If the document hasn't been loaded yet then
DocumentViewer will wait to finish loading it until the watermark options are ready.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Object that contains style/content of the watermark
<h6 class="method-params-label method-subparams-label">Properties</h6>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>diagonal</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">Settings for a diagonal watermark
<h6 class="method-params-label method-subparams-label">Properties</h6>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">The text content to be rendered as a diagonal watermark</td>
</tr>
<tr>
<td class="name"><code>fontSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
20
</td>
<td class="description last">The font size of the text, measured in pixels (px)</td>
</tr>
<tr>
<td class="name"><code>fontFamily</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'sans-serif'
</td>
<td class="description last">The font type</td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'black'
</td>
<td class="description last">The color of the text</td>
</tr>
<tr>
<td class="name"><code>opacity</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
100
</td>
<td class="description last">The percentage of opacity for the watermark</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>header</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">Settings for a header watermark
<h6 class="method-params-label method-subparams-label">Properties</h6>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>left</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">The text content to be rendered at the left side of the header</td>
</tr>
<tr>
<td class="name"><code>center</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">The text content to be rendered at the center of the header</td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">The text content to be rendered at the right side of the header</td>
</tr>
<tr>
<td class="name"><code>fontSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
20
</td>
<td class="description last">The font size of the text, measured in pixels (px)</td>
</tr>
<tr>
<td class="name"><code>fontFamily</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'sans-serif'
</td>
<td class="description last">The font type</td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'black'
</td>
<td class="description last">The color of the text</td>
</tr>
<tr>
<td class="name"><code>opacity</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
100
</td>
<td class="description last">The percentage of opacity for the watermark</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>footer</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">Settings for a footer watermark
<h6 class="method-params-label method-subparams-label">Properties</h6>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>left</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">The text content to be rendered at the left side of the footer</td>
</tr>
<tr>
<td class="name"><code>center</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">The text content to be rendered at the center of the footer</td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">The text content to be rendered at the right side of the footer</td>
</tr>
<tr>
<td class="name"><code>fontSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
20
</td>
<td class="description last">The font size of the text, measured in pixels (px)</td>
</tr>
<tr>
<td class="name"><code>fontFamily</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'sans-serif'
</td>
<td class="description last">The font type</td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'black'
</td>
<td class="description last">The color of the text</td>
</tr>
<tr>
<td class="name"><code>opacity</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
100
</td>
<td class="description last">The percentage of opacity for the watermark</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>custom</code></td>
<td class="type">
<span class="param-type"><a href="Core.DocumentViewer.html#.CustomWatermarkCallback">Core.DocumentViewer.CustomWatermarkCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">Function that is invoked for each page, to fully customize which page(s) have a watermark render, and how they should be rendered.</td>
</tr>
<tr>
<td class="name"><code>shouldDrawOverAnnotations</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">Toggles if the watermark should be drawn over annotations</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">docViewer.setWatermark({
diagonal: {
text: (string),
fontSize: (number || 20),
fontFamily: (string || 'sans-serif'),
color: (string || 'black'),
opacity: (number || 100)
},
header: {
left: (string),
center: (string),
right: (string),
fontSize: (number || 20),
fontFamily: (string || 'sans-serif'),
color: (string || 'black'),
opacity: (number || 100)
},
footer: {
left: (string)
center: (string),
right: (string),
fontSize: (number || 20),
fontFamily: (string || 'sans-serif'),
color: (string || 'black'),
opacity: (number || 100),
},
custom: (function(ctx, pageIndex, pageWidth, pageHeight)),
shouldDrawOverAnnotations: (boolean || false)
});</pre>
</dd>
<hr>
<dt>
<h4 class="name" id="snapToNearest"><span class="type-signature"></span>snapToNearest(pageNumber, x, y [, mode])</h4>
</dt>
<dd>
<div class="description">
Returns the path coordinate within the page that is closest to the queried point.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The page number the point is on</td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The x position to calculate the snap point from</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The y position to calculate the snap point from</td>
</tr>
<tr>
<td class="name"><code>mode</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Enum for an optional snapping mode for the snapping</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A promise that resolves to the SnapData object.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="Core.DocumentViewer.html#.SnapData">Core.DocumentViewer.SnapData</a>></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="stopPageRender"><span class="type-signature"></span>stopPageRender(pageNumber)</h4>
</dt>
<dd>
<div class="description">
Stops the rendering of the specified page.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The number of the page who's rendering should be stopped.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="textSearchInit"><span class="type-signature"></span>textSearchInit(pattern, mode [, searchOptions])</h4>
</dt>
<dd>
<div class="description">
Searches for a particular text string on the currently displayed Document, starting on the current page unless otherwise specified.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pattern</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last">The text to search for.</td>
</tr>
<tr>
<td class="name"><code>mode</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The options for search, controlling options such as case sensitivity and search direction.</td>
</tr>
<tr>
<td class="name"><code>searchOptions</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An object that can contain the following optional parameters
<h6 class="method-params-label method-subparams-label">Properties</h6>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fullSearch</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If true, a search of the entire document will be performed. Otherwise, a single search will be performed.</td>
</tr>
<tr>
<td class="name"><code>onResult</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">(result) The callback function that is called when the search returns a result.</td>
</tr>
<tr>
<td class="name"><code>onPageEnd</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">(result) The callback function that is called when reaching the end of the page (if using page_stop mode).</td>
</tr>
<tr>
<td class="name"><code>onDocumentEnd</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">() The callback function that is called when reaching the end of the document.</td>
</tr>
<tr>
<td class="name"><code>onError</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">(result) The callback function that is called when search failed or regex has syntax error.</td>
</tr>
<tr>
<td class="name"><code>startPage</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Page to start the search on (1-indexed).</td>
</tr>
<tr>
<td class="name"><code>endPage</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Page to end the search on inclusively (1-indexed).
The search may complete when the search term is found, when the entire document has been searched, and, depending on the search options, at the end of every page. Parameter result: DocumentViewer.SearchResults.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
<dd class="tag-see">
<ul>
<li>Core.DocumentViewer#SearchMode</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="trigger"><span class="type-signature"></span>trigger(type [, data])</h4>
</dt>
<dd>
<div class="description">
Calls the handlers of the event name with given data
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">event name of which the handlers will be called.</td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">data that will be passed to the handlers.
If data is an array, it will be spread and then passed to the handlers</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
<dd class="inherited-from">
<ul class="dummy">
<li>
<a href="Core.EventHandler.html#trigger">Core.EventHandler#trigger</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns the object that 'trigger' is being called on
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">myObject.trigger('eventName');
myObject.trigger('eventName', [eventParameter1, eventParameter2]);</pre>
</dd>
<hr>
<dt>
<h4 class="name" id="updateLinks"><span class="type-signature"></span>updateLinks(pageNumber)</h4>
</dt>
<dd>
<div class="description">
Updates old xod (version <= 1.2) link annotations in the annotation manager
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The 1-indexed page number to update</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="updateView"><span class="type-signature"></span>updateView( [visiblePages] [, currentPageNumber])</h4>
</dt>
<dd>
<div class="description">
Removes previously drawn pages that are no longer visible and
draws pages that are visible and have not been drawn.
If visiblePages are provided then those pages are rendered otherwise visiblePages are calculated
depending on where the DIV elements for the pages are located.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>visiblePages</code></td>
<td class="type">
<span class="param-type">Array.<number></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An array of integers representing the pages to render.</td>
</tr>
<tr>
<td class="name"><code>currentPageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The number of the page that is currently visible in the viewer.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="updateVisiblePages"><span class="type-signature"></span>updateVisiblePages( [visiblePages])</h4>
</dt>
<dd>
<div class="description">
Notifies the document viewer that the visible pages have changed
but does not draw any pages.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>visiblePages</code></td>
<td class="type">
<span class="param-type">Array.<number></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An array of integers representing the pages to render.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="zoomTo"><span class="type-signature"></span>zoomTo(zoom [, x] [, y])</h4>
</dt>
<dd>
<div class="description">
Adjusts the viewer's zoom factor, and positions the point (x,y) at the upper left corner of the viewer.
Only renders if a document has been loaded.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>zoom</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">Zoom value.</td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Horizontal position to scroll to.</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Vertical position to scroll to.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="zoomToMouse"><span class="type-signature"></span>zoomToMouse(zoom, offsetX, offsetY)</h4>
</dt>
<dd>
<div class="description">
Adjusts the viewer's zoom factor and positions the point on the document under the mouse at the same position
after zooming in.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>zoom</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Zoom value</td>
</tr>
<tr>
<td class="name"><code>offsetX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The x offset from the mouse position to the viewer's position (e.g. taking into account toolbars)</td>
</tr>
<tr>
<td class="name"><code>offsetY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The y offset from the mouse position to the viewer's position (e.g. taking into side panels)</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<dl>
<hr>
<dt>
<h4 class="name" id=".CustomWatermarkCallback"><span class="type-signature"></span>CustomWatermarkCallback(ctx, pageIndex, pageWidth, pageHeight)</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ctx</code></td>
<td class="type">
<span class="param-type">CanvasRenderingContext2D</span>
</td>
<td class="description last">The <a href="https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D">Canvas Context</a> that determines how the watermark will be rendered.
Edit the <a href="https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D#Text_styles">text styles attributes</a> to change the rendering styling.</td>
</tr>
<tr>
<td class="name"><code>pageIndex</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The index of the current page</td>
</tr>
<tr>
<td class="name"><code>pageWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The width of the current page</td>
</tr>
<tr>
<td class="name"><code>pageHeight</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The height of the current page</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".DocumentXFDFRetriever"><span class="type-signature"></span>DocumentXFDFRetriever(docId)</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>docId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the id of the document that is being loaded</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A promise that resolves to an XFDF string, or an array of XFDF commands
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<(string|Array.<string>)></span>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".SnapData">
<h4 id=".SnapData">SnapData</h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The x position of the nearestPoint</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The y position of the nearestPoint</td>
</tr>
<tr>
<td class="name"><code>mode</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The effective mode that was used to find this snap point.</td>
</tr>
<tr>
<td class="name"><code>modeName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The name of the effective mode that was used to find this snap point.</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Events</h3>
<dl>
<hr>
<dt>
<h4 class="name" id="event:activeSearchResultChanged">activeSearchResultChanged</h4>
</dt>
<dd>
<div class="description">
Triggered when the active search result has changed
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The new active search result, Core.DocumentViewer.SearchResult.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:annotationsLoaded">annotationsLoaded</h4>
</dt>
<dd>
<div class="description">
Triggered when all the annotations embedded in the document have been loaded
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:beforeDocumentLoaded">beforeDocumentLoaded</h4>
</dt>
<dd>
<div class="description">
Triggered just before the document has been loaded into the viewer
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:beginRendering">beginRendering</h4>
</dt>
<dd>
<div class="description">
Triggered when DocumentViewer starts rendering pages
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:click">click</h4>
</dt>
<dd>
<div class="description">
Triggered for the click event in the DocumentViewer's viewing area
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nativeEvt</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Event object of the native JavaScript event</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:dblClick">dblClick</h4>
</dt>
<dd>
<div class="description">
Triggered for the dblClick event in the DocumentViewer's viewing area
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nativeEvt</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Event object of the native JavaScript event</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:displayModeUpdated">displayModeUpdated</h4>
</dt>
<dd>
<div class="description">
Triggered when the display mode is updated
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:displayPageLocation">displayPageLocation</h4>
</dt>
<dd>
<div class="description">
Triggered when a page location should be displayed
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNum</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The 1-indexed page number</td>
</tr>
<tr>
<td class="name"><code>verticalOffset</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The offset from the top of the page</td>
</tr>
<tr>
<td class="name"><code>horizontalOffset</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The offset from the left of the page</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:documentLoaded">documentLoaded</h4>
</dt>
<dd>
<div class="description">
Triggered when a new document has been loaded
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:documentUnloaded">documentUnloaded</h4>
</dt>
<dd>
<div class="description">
Triggered when the current document has been closed and unloaded
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:embeddedThumbnailComplete">embeddedThumbnailComplete</h4>
</dt>
<dd>
<div class="description">
Triggered when an embedded thumbnail of a viewer-optimized pdf is completely loaded.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNum</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The 1-indexed page number</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:finishedRendering">finishedRendering</h4>
</dt>
<dd>
<div class="description">
Triggered when DocumentViewer finishes rendering pages
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:fitModeUpdated">fitModeUpdated</h4>
</dt>
<dd>
<div class="description">
Triggered when the fit mode has changed
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fitMode</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The fit mode that has been changed to e.g. docViewer.FitMode.FitWidth</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:keyDown">keyDown</h4>
</dt>
<dd>
<div class="description">
Triggered for the keyDown event in the DocumentViewer's viewing area
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nativeEvt</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Event object of the native JavaScript event</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:keyUp">keyUp</h4>
</dt>
<dd>
<div class="description">
Triggered for the keyUp event in the DocumentViewer's viewing area
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nativeEvt</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Event object of the native JavaScript event</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:mouseEnter">mouseEnter</h4>
</dt>
<dd>
<div class="description">
Triggered for the mouseEnter event in the DocumentViewer's viewing area
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nativeEvt</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Event object of the native JavaScript event</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:mouseLeave">mouseLeave</h4>
</dt>
<dd>
<div class="description">
Triggered for the mouseLeave event in the DocumentViewer's viewing area
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nativeEvt</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Event object of the native JavaScript event</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:mouseLeftDown">mouseLeftDown</h4>
</dt>
<dd>
<div class="description">
Triggered for the mouseLeftButtonDown event in the DocumentViewer's viewing area
Attach like docViewer.addEventListener('mouseLeftDown', callback)
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nativeEvt</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Event object of the native JavaScript event</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:mouseLeftUp">mouseLeftUp</h4>
</dt>
<dd>
<div class="description">
Triggered for the mouseLeftButtonUp event in the DocumentViewer's viewing area
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nativeEvt</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Event object of the native JavaScript event</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:mouseMove">mouseMove</h4>
</dt>
<dd>
<div class="description">
Triggered for the mouseMove event in the DocumentViewer's viewing area
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nativeEvt</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Event object of the native JavaScript event</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:mouseRightDown">mouseRightDown</h4>
</dt>
<dd>
<div class="description">
Triggered for the mouseRightButtonDown event in the DocumentViewer's viewing area
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nativeEvt</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Event object of the native JavaScript event</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:mouseRightUp">mouseRightUp</h4>
</dt>
<dd>
<div class="description">
Triggered for the mouseRightButtonUp event in the DocumentViewer's viewing area
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nativeEvt</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Event object of the native JavaScript event</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:notify">notify</h4>
</dt>
<dd>
<div class="description">
Triggered when there is a notification relating to searching or annotation permissions.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The type of notification that has occurred</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:pageComplete">pageComplete</h4>
</dt>
<dd>
<div class="description">
Triggered when a page has been completely rendered.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNum</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The 1-indexed page number</td>
</tr>
<tr>
<td class="name"><code>canvas</code></td>
<td class="type">
<span class="param-type">HTMLCanvasElement</span>
</td>
<td class="description last">The canvas for the page</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:pageNumberUpdated">pageNumberUpdated</h4>
</dt>
<dd>
<div class="description">
Triggered when the page number is updated
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The new page number (1-indexed)</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:pagesUpdated">pagesUpdated</h4>
</dt>
<dd>
<div class="description">
Triggered when the layout has changed because pages have permanently been added, removed, moved or changed in some other way.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>changes</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">An object with keys added, removed, moved and contentChanged, indicating which pages have changed</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:rotationUpdated">rotationUpdated</h4>
</dt>
<dd>
<div class="description">
Triggered when the page rotation has changed
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.html#.PageRotation">Core.PageRotation</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">The new viewing rotation.</td>
</tr>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Optionally the specific page number that had its rotation changed</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:searchInProgress">searchInProgress</h4>
</dt>
<dd>
<div class="description">
Triggered when a search starts or ends.
When <a href="Core.DocumentViewer.html#clearSearchResults">Core.DocumentViewer#clearSearchResults</a> is executed searchInProgress event is triggered with both inProgress and isFullSearch
arguments to be undefined. This can be used to differentiate the search that hasn’t been started versus the search that was done.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>inProgress</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether a search is in progress or not</td>
</tr>
<tr>
<td class="name"><code>isFullSearch</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether this is a full text search or not</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:searchResultsChanged">searchResultsChanged</h4>
</dt>
<dd>
<div class="description">
Triggered when the search results list has changed
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>results</code></td>
<td class="type">
<span class="param-type">Array.<object></span>
</td>
<td class="description last">The new search results, Core.DocumentViewer.SearchResult.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:tap">tap</h4>
</dt>
<dd>
<div class="description">
Triggered when there is a tap in the DocumentViewer's viewing area. Taps are defined as a mouse down and up within a short time period and within a short distance.a
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nativeEvt</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Event object of the native JavaScript event</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:textSelected">textSelected</h4>
</dt>
<dd>
<div class="description">
Triggered when the selected text has changed
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>quads</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Math.Quad.html">Core.Math.Quad</a>></span>
</td>
<td class="description last">An array of bounding box quads of the selected text</td>
</tr>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The selected text</td>
</tr>
<tr>
<td class="name"><code>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page number that the text was selected on</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:toolModeUpdated">toolModeUpdated</h4>
</dt>
<dd>
<div class="description">
Triggered when the tool mode has changed
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>newToolObject</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The tool object that has been changed to.</td>
</tr>
<tr>
<td class="name"><code>oldToolObject</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The tool object that has been changed from.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:toolUpdated">toolUpdated</h4>
</dt>
<dd>
<div class="description">
Triggered when the tool styles or tool name have changed
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>toolModeClass</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The tool object that has been changed.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:zoomUpdated">zoomUpdated</h4>
</dt>
<dd>
<div class="description">
Triggered when the zoom level has been updated
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>zoom</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The new zoom level of the viewer</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
</dl>
</article>
</section>
</div>
</div>
<div class="clearfix"></div>
<div class="col-md-3">
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
</div>
</div>
</div>
<div class="modal fade" id="searchResults">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body"></div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>
<footer>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
on 2023-06-16T14:56:46-07:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : false,
showMenu : true,
enableDoclinks : true
} );
$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
<script type="text/javascript">
$(document).ready(function() {
SearcherDisplay.init();
});
</script>
</body>
</html>