| 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: AnnotationManager</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: AnnotationManager</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="Core.html">Core</a>.</span>
AnnotationManager
</h2>
<div class="class-description">Represents an object that manages the Annotations that appear on a Document's pages when displayed in a DocumentViewer.</div>
</header>
<article>
<div class="container-overview">
<hr>
<dt>
<h4 class="name" id="AnnotationManager"><span class="type-signature"></span>new AnnotationManager(docViewer)</h4>
</dt>
<dd>
<div class="description">
Creates a new instance of AnnotationManager.
</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>docViewer</code></td>
<td class="type">
<span class="param-type"><a href="Core.DocumentViewer.html">Core.DocumentViewer</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<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>controlPointSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The size of annotation control points.</td>
</tr>
<tr>
<td class="name"><code>controlPointHitBoxScale</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The scale of the hit box of the annotation control points. Increase to increase the selectable area.</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=".AnnotationChangedActions">
<h4 id=".AnnotationChangedActions"><span class="type-signature"><static> </span>AnnotationChangedActions</h4>
</dt>
<dd>
<div class="description">
The different action types for the annotationChanged event.
</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>ADD</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">When the annotationChanged event triggered due to adding annotations</td>
</tr>
<tr>
<td class="name"><code>DELETE</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">When the annotationChanged event triggered due to deleting annotations</td>
</tr>
<tr>
<td class="name"><code>MODIFY</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">When the annotationChanged event triggered due to modifying annotations</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<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>ANNOTATION_SELECTED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.AnnotationManager.html#event:annotationSelected">Core.AnnotationManager.annotationSelected </a></td>
</tr>
<tr>
<td class="name"><code>ANNOTATION_DESELECTED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.AnnotationManager.html#event:annotationDeselected">Core.AnnotationManager.annotationDeselected </a></td>
</tr>
<tr>
<td class="name"><code>ANNOTATION_DOUBLE_CLICKED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.AnnotationManager.html#event:annotationDoubleClicked">Core.AnnotationManager.annotationDoubleClicked </a></td>
</tr>
<tr>
<td class="name"><code>ANNOTATION_CHANGED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.AnnotationManager.html#event:annotationChanged">Core.AnnotationManager.annotationChanged </a></td>
</tr>
<tr>
<td class="name"><code>UPDATE_ANNOTATION_PERMISSION</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.AnnotationManager.html#event:updateAnnotationPermission">Core.AnnotationManager.updateAnnotationPermission </a></td>
</tr>
<tr>
<td class="name"><code>ANNOTATIONS_DRAWN</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.AnnotationManager.html#event:annotationsDrawn">Core.AnnotationManager.annotationsDrawn </a></td>
</tr>
<tr>
<td class="name"><code>ANNOTATION_HIDDEN</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.AnnotationManager.html#event:annotationHidden">Core.AnnotationManager.annotationHidden </a></td>
</tr>
<tr>
<td class="name"><code>SET_NOTE_TEXT</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.AnnotationManager.html#event:setNoteText">Core.AnnotationManager.setNoteText </a></td>
</tr>
<tr>
<td class="name"><code>ADD_REPLY</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.AnnotationManager.html#event:addReply">Core.AnnotationManager.addReply </a></td>
</tr>
<tr>
<td class="name"><code>DELETE_REPLY</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.AnnotationManager.html#event:deleteReply">Core.AnnotationManager.deleteReply </a></td>
</tr>
<tr>
<td class="name"><code>FIELD_CHANGED</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.AnnotationManager.html#event:fieldChanged">Core.AnnotationManager.fieldChanged </a></td>
</tr>
<tr>
<td class="name"><code>FILE_ATTACHMENT_DATA_AVAILABLE</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><a href="Core.AnnotationManager.html#event:fileAttachmentDataAvailable">Core.AnnotationManager.fileAttachmentDataAvailable </a></td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".RotationTypes">
<h4 id=".RotationTypes"><span class="type-signature"><static> </span>RotationTypes</h4>
</dt>
<dd>
<div class="description">
Represents the types of rotations available to perform on an annotation.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</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>SNAP_ROTATION</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Rotate an annotation in discrete steps, such as 45 or 90 degrees</td>
</tr>
<tr>
<td class="name"><code>FREEFORM_ROTATION</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Rotate an annotation continuously</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<hr>
<dt>
<h4 class="name" id="addAnnotation"><span class="type-signature"></span>addAnnotation(annotation [, options])</h4>
</dt>
<dd>
<div class="description">
Adds the specified annotation to the managed list of annotations.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
|
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="attributes">
</td>
<td class="description last">An instance of Annotation.</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">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>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>imported</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">Whether the annotation was imported from another source or not</td>
</tr>
<tr>
<td class="name"><code>isUndoRedo</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">Whether the annotation change was caused by undo/redo or not</td>
</tr>
<tr>
<td class="name"><code>autoFocus</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">Whether the annotation's text input should be automatically focused if applicable. Relevant to FreeText and Callout annotations.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="addAnnotations"><span class="type-signature"></span>addAnnotations(annotations [, options])</h4>
</dt>
<dd>
<div class="description">
Adds the specified annotations to the managed list of annotations.
</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>annotations</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="attributes">
</td>
<td class="description last">An array of annotations.</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">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>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>imported</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">Whether the annotations were imported from another source or not</td>
</tr>
<tr>
<td class="name"><code>isUndoRedo</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">Whether the annotation change was caused by undo/redo or not</td>
</tr>
<tr>
<td class="name"><code>autoFocus</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">Whether the annotation's text input should be automatically focused if applicable. Relevant to FreeText and Callout annotations.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<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="applyRedactions"><span class="type-signature"></span>applyRedactions( [annotations])</h4>
</dt>
<dd>
<div class="description">
Apply redaction annotations
</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>annotations</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
|
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An array of redaction annotations or a single redaction annotation.
If nothing passed, apply all redactions. If the redaction annotations overlap with other annotations, it calls deleteAnnotations on the other annotations.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns a promise that resolves with an array of redaction info when the redactions have been applied.
If using WebViewer server, the promise will resolve with a URL to the redacted document.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<(Array.<<a href="Core.AnnotationManager.html#.RedactionInfo">Core.AnnotationManager.RedactionInfo</a>>|string)></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="bringToBack"><span class="type-signature"></span>bringToBack(annotation)</h4>
</dt>
<dd>
<div class="description">
Move the annotation to the beginning of the managed list of annotations, so that it will be shown behind all annotations.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation that will be shown in the back.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="bringToFront"><span class="type-signature"></span>bringToFront(annotation)</h4>
</dt>
<dd>
<div class="description">
Move the annotation to the end of the managed list of annotations, so that it will be shown on top of all annotations.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation that will be shown in the front.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="canModify"><span class="type-signature"></span>canModify(annotation)</h4>
</dt>
<dd>
<div class="description">
Whether or not the current user can modify the annotation.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation to check permissions on.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Whether the annotation can be modified or not.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="canModifyContents"><span class="type-signature"></span>canModifyContents(annotation)</h4>
</dt>
<dd>
<div class="description">
Whether or not the current user can modify the annotation's contents.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation to check permissions on.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Whether the annotation's contents can be modified or not.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="createAnnotationReply"><span class="type-signature"></span>createAnnotationReply(annotation, initialText)</h4>
</dt>
<dd>
<div class="description">
Creates an annotation that replies to the passed in annotation. Annotation replies are sticky note annotations.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation to add a reply to</td>
</tr>
<tr>
<td class="name"><code>initialText</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The initialText for the annotation, defaults to the empty string</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The created annotation reply
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.Annotations.StickyAnnotation.html">Core.Annotations.StickyAnnotation</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="deleteAnnotation"><span class="type-signature"></span>deleteAnnotation(annotation [, options])</h4>
</dt>
<dd>
<div class="description">
Deletes the specified annotation in the managed list of annotations.
If an annotation is successfully deleted, the annotationChanged event will be fired with a "delete" action.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
|
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="attributes">
</td>
<td class="description last">An instance of Annotation.</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">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>imported</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Whether the annotation was imported from another source or not OR a option parameters contains</td>
</tr>
<tr>
<td class="name"><code>force</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 the annotation will be deleted regardless of the user's current permissions</td>
</tr>
<tr>
<td class="name"><code>isUndoRedo</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Whether the annotation change was caused by undo/redo or not</td>
</tr>
<tr>
<td class="name"><code>source</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">What type of action cause this event (i.e. "redactionApplied")</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="deleteAnnotations"><span class="type-signature"></span>deleteAnnotations(annotation [, options])</h4>
</dt>
<dd>
<div class="description">
Deletes the specified annotations in the managed list of annotations.
If an annotation is successfully deleted, the annotationChanged event will be fired with a "delete" action.
</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>annotation</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="attributes">
</td>
<td class="description last">An array of annotations</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">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>imported</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Whether the annotations were imported from another source or not</td>
</tr>
<tr>
<td class="name"><code>force</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 the annotations will be deleted regardless of the user's current permissions</td>
</tr>
<tr>
<td class="name"><code>isUndoRedo</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Whether the annotation change was caused by undo/redo or not</td>
</tr>
<tr>
<td class="name"><code>source</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">What type of action cause this event (i.e. "redactionApplied")</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="demoteUserFromAdmin"><span class="type-signature"></span>demoteUserFromAdmin()</h4>
</dt>
<dd>
<div class="description">
Demote the current user so they are no longer an admin user.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="deregisterAnnotationType"><span class="type-signature"></span>deregisterAnnotationType(elementName, annotationClass)</h4>
</dt>
<dd>
<div class="description">
Deregisters an annotation class.
</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>elementName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the string representing the xml element name of the annotation</td>
</tr>
<tr>
<td class="name"><code>annotationClass</code></td>
<td class="type">
<span class="param-type">Class.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="description last">the class (constructor) of the annotation</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if deregistration was successful
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="deselectAllAnnotations"><span class="type-signature"></span>deselectAllAnnotations()</h4>
</dt>
<dd>
<div class="description">
Deselects all annotations.
If an annotation is successfully deselected then the annotationSelected event will be triggered with two parameters: an array of annotations that were deselected and a "deselected" action.
Note: the annotationSelected event has two parameters: an array of annotations and a string value of either "selected" or "deselected"
The annotationDeselected event will also be triggered with one parameter: an array of annotations that were deselected.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="deselectAnnotation"><span class="type-signature"></span>deselectAnnotation(annotation)</h4>
</dt>
<dd>
<div class="description">
Deselects the specified annotation.
If an annotation is successfully deselected then the annotationSelected event will be fired with a "deselected" action.
Note: the annotationSelected event has two parameters: an array of annotations and a string value of either "selected" or "deselected"
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">An instance of Annotation.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="deselectAnnotations"><span class="type-signature"></span>deselectAnnotations(annotations)</h4>
</dt>
<dd>
<div class="description">
Deselects the specified annotations.
If annotations are successfully deselected then the annotationSelected event will be fired with a "deselected" action.
Note: the annotationSelected event has two parameters: an array of annotations and a string value of either "selected" or "deselected"
</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>annotations</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="description last">An array of annotation instances</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableDraggingAcrossPages"><span class="type-signature"></span>disableDraggingAcrossPages()</h4>
</dt>
<dd>
<div class="description">
Disable dragging annotations across pages.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableFreeformRotation"><span class="type-signature"></span>disableFreeformRotation()</h4>
</dt>
<dd>
<div class="description">
Disables freeform rotation for annotations.
</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.2
Please use setRotationOptions instead</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableFreeTextEditing"><span class="type-signature"></span>disableFreeTextEditing()</h4>
</dt>
<dd>
<div class="description">
Disables the editing of free text annotations directly on the annotation.
</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="disableRedaction"><span class="type-signature"></span>disableRedaction()</h4>
</dt>
<dd>
<div class="description">
Disable redaction tools
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="disableStampVectorAppearance"><span class="type-signature"></span>disableStampVectorAppearance()</h4>
</dt>
<dd>
<div class="description">
Disables the use of vector appearances for stamp annotations and always uses a fixed size bitmap.
This may be much faster in certain situations but will appear blurry at higher zoom levels.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="drawAnnotations"><span class="type-signature"></span>drawAnnotations(options)</h4>
</dt>
<dd>
<div class="description">
Draws all annotations associated with the given page number.
Note that the entire annotation canvas for the page will be redrawn.
</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 object that can contain the following 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>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The page number of the page to draw</td>
</tr>
<tr>
<td class="name"><code>overrideCanvas</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Optionally draw directly to this canvas</td>
</tr>
<tr>
<td class="name"><code>majorRedraw</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Signify that this is a major redraw, so widget-like annotations must be re-rendered as well</td>
</tr>
<tr>
<td class="name"><code>overrideContainer</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Optionally the container HTML element that the widget annotations should be appended to</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns a promise that resolves when all the annotations on the page have been drawn
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<any></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="drawAnnotationsFromList"><span class="type-signature"></span>drawAnnotationsFromList(annotationList)</h4>
</dt>
<dd>
<div class="description">
Draws all the pages associated with the annotations in the list as long the page is visible.
A single annotation can also be passed 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>annotationList</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
|
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">List of annotations or a single annotation object</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns a promise that resolves when all the annotations in the annotationList have been drawn
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<any></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="enableDraggingAcrossPages"><span class="type-signature"></span>enableDraggingAcrossPages()</h4>
</dt>
<dd>
<div class="description">
Enable dragging annotations across pages.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="enableFreeformRotation"><span class="type-signature"></span>enableFreeformRotation()</h4>
</dt>
<dd>
<div class="description">
Enables freeform rotation for annotations
</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.2
Please use setRotationOptions instead</li>
</ul>
</dd>
</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 annotations can be added or commented on.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="enableRedaction"><span class="type-signature"></span>enableRedaction()</h4>
</dt>
<dd>
<div class="description">
Enable redaction tools
Please use enableRedaction or disableRedaction without passing parameters
Using a parameter is deprecated in version 8.0
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="exportAnnotationCommand"><span class="type-signature"></span>exportAnnotationCommand()</h4>
</dt>
<dd>
<div class="description">
Gets an XML string from the last time this function was called.
XML string specifies the added, modified and deleted annotations.
Added and modified annotations will have their XFDF representation included
while deleted annotations will only include their id.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns a promise that resolves to an XFDF command string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<string></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="exportAnnotations"><span class="type-signature"></span>exportAnnotations( [options])</h4>
</dt>
<dd>
<div class="description">
Exports all annotations as an XFDF (XML) string
</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>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Options for the export. Set options.widgets or options.links or options.fields to false to disable exporting of them.
<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>annotList</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An array of annotations to only export the XFDF for those particular annotations.</td>
</tr>
<tr>
<td class="name"><code>widgets</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Whether to export widget information</td>
</tr>
<tr>
<td class="name"><code>links</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Whether to export links information</td>
</tr>
<tr>
<td class="name"><code>fields</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Whether to export fields information</td>
</tr>
<tr>
<td class="name"><code>useDisplayAuthor</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Whether to export annotations with the Display Author name from annotationManager.getDisplayAuthor()</td>
</tr>
<tr>
<td class="name"><code>generateInlineAppearances</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Whether to generate custom appearance strings for annotations that have an appearance generated on export (e.g. freetext). Default: true</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns a promise that resolves with the XFDF (XML) annotations as a string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<string></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="exportAnnotCommand"><span class="type-signature"></span>exportAnnotCommand()</h4>
</dt>
<dd>
<div class="description">
Gets an XML string from the last time this function was called.
XML string specifies the added, modified and deleted annotations.
Added and modified annotations will have their XFDF representation included
while deleted annotations will only include their id.
</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.
Please use <a href="Core.AnnotationManager.html#exportAnnotationCommand">exportAnnotationCommand</a> instead</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns a promise that resolves to an XFDF command string
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<string></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getAnnotationById"><span class="type-signature"></span>getAnnotationById(id [, annotationList])</h4>
</dt>
<dd>
<div class="description">
Gets an annotation object by the annotation's ID.
</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>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last">The ID of the annotation.</td>
</tr>
<tr>
<td class="name"><code>annotationList</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Optionally pass your own array of annotations to search in</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
An annotation object.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getAnnotationByMouseEvent"><span class="type-signature"></span>getAnnotationByMouseEvent(event)</h4>
</dt>
<dd>
<div class="description">
Gets the top-most annotation using a DOM mouse event. This method can be used to test if a mouse point will hit any annotations on pages.
</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">
An annotation object.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getAnnotationCopy"><span class="type-signature"></span>getAnnotationCopy(annotation, options)</h4>
</dt>
<dd>
<div class="description">
Returns a deep copy of the annotation
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">An instance of Annotation to be copied.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Options for this function
<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>copyAssociatedLink</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether to make a deep copy of an associated link</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
a copy of the annotation, null if annotation cannot be copied
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getAnnotationFromPopup"><span class="type-signature"></span>getAnnotationFromPopup(popup)</h4>
</dt>
<dd>
<div class="description">
Gets the annotation associated with the popup object.
</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>popup</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The popup object associated with an annotation</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The annotation that the popup belongs to
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getAnnotationsByMouseEvent"><span class="type-signature"></span>getAnnotationsByMouseEvent(event)</h4>
</dt>
<dd>
<div class="description">
Gets the annotations underneath the cursor using a DOM mouse event. This method can be used to test if a mouse point will hit annotations on pages.
</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">
An array of annotation objects.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getAnnotationsList"><span class="type-signature"></span>getAnnotationsList()</h4>
</dt>
<dd>
<div class="description">
Gets the list of all annotations managed by the AnnotationManager.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
An array of Annotations.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getCopiedAnnotations"><span class="type-signature"></span>getCopiedAnnotations()</h4>
</dt>
<dd>
<div class="description">
Get copied annotations.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
returns array of copied annotations
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getCurrentUser"><span class="type-signature"></span>getCurrentUser()</h4>
</dt>
<dd>
<div class="description">
Returns the user name of the current user.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The user name of the current user.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getDisplayAuthor"><span class="type-signature"></span>getDisplayAuthor(annotationUserId)</h4>
</dt>
<dd>
<div class="description">
Annotations may set the author to a unique id which isn't suitable for display in the UI.
this function gets the author name of the annotation that 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>annotationUserId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Annotation userId</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The display author name
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getEditBoxManager"><span class="type-signature"></span>getEditBoxManager()</h4>
</dt>
<dd>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns an instance of EditorBoxManager
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.EditBoxManager.html">Core.EditBoxManager</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getFieldManager"><span class="type-signature"></span>getFieldManager()</h4>
</dt>
<dd>
<div class="description">
Gets the associated field manager.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.Annotations.Forms.FieldManager.html">Core.Annotations.Forms.FieldManager</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getGroupAnnotations"><span class="type-signature"></span>getGroupAnnotations(annotation)</h4>
</dt>
<dd>
<div class="description">
Gets all the annotations that are grouped with the passed in annotation, including said annotation.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">An annotation in the group</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Gets all the annotations that are grouped with the passed in annotation, including said annotation.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getIsAdminUser"><span class="type-signature"></span>getIsAdminUser()</h4>
</dt>
<dd>
<div class="description">
Returns whether the current user has admin privileges.
</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.AnnotationManager.html#isUserAdmin">isUserAdmin</a> instead.</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if the current user is an admin, false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getNumberOfGroups"><span class="type-signature"></span>getNumberOfGroups()</h4>
</dt>
<dd>
<div class="description">
Gets the number of annotations in the current selection
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The number of groups in the current selection. A loose annotation is a group of 1.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getReadOnly"><span class="type-signature"></span>getReadOnly()</h4>
</dt>
<dd>
<div class="description">
Returns whether the viewer is currently in read-only mode.
</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.AnnotationManager.html#isReadOnlyModeEnabled">isReadOnlyModeEnabled</a> instead.</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if the current viewer is in read-only mode, false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getRegisteredAnnotationTypes"><span class="type-signature"></span>getRegisteredAnnotationTypes()</h4>
</dt>
<dd>
<div class="description">
Gets a map of registered annotations. This can be modified directly, instead of using AnnotationManager#registerAnnotationType and AnnotationManager#deregisterAnnotationType.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
a JavaScript object containing a key-value map, where the key is the annotation element name and the value is an array of Annotation classes.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getRootAnnotation"><span class="type-signature"></span>getRootAnnotation(annotation)</h4>
</dt>
<dd>
<div class="description">
Gets the root annotation that this annotation is replying to.
If this annotation is not replying to anything then the root is itself.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation from which to find the root annotation in the reply chain</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The root annotation
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getRotationOptions"><span class="type-signature"></span>getRotationOptions()</h4>
</dt>
<dd>
<div class="description">
Gets the rotation options for annotation manager.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
An object containing rotation options for annotation manager.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">const { Core } = instance;
const annotManager = Core.documentViewer.getAnnotationManager();
const rotationOptions = annotManager.getRotationOptions();</pre>
</dd>
<hr>
<dt>
<h4 class="name" id="getSelectedAnnotations"><span class="type-signature"></span>getSelectedAnnotations()</h4>
</dt>
<dd>
<div class="description">
Returns the list of selected annotations.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
An array of selected annotations.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getSnapDefaultOptions"><span class="type-signature"></span>getSnapDefaultOptions()</h4>
</dt>
<dd>
<div class="description">
Get the current snap options for annotation tool snapping
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The snap mode options.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.AnnotationManager.html#.snapDefaultOptions">Core.AnnotationManager.snapDefaultOptions</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="groupAnnotations"><span class="type-signature"></span>groupAnnotations(primaryAnnotation, annotations)</h4>
</dt>
<dd>
<div class="description">
Groups an array of annotations
</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>primaryAnnotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The primary annotation for this group.</td>
</tr>
<tr>
<td class="name"><code>annotations</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="description last">The array of annotations to group.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="hasAnnotation"><span class="type-signature"></span>hasAnnotation(annotation)</h4>
</dt>
<dd>
<div class="description">
Determines if the specified annotation exists in the managed list of annotations.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">An instance of Annotation.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="hideAnnotation"><span class="type-signature"></span>hideAnnotation(annot)</h4>
</dt>
<dd>
<div class="description">
Hides the specified annotation.
</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>annot</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation to hide</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="hideAnnotations"><span class="type-signature"></span>hideAnnotations(annots)</h4>
</dt>
<dd>
<div class="description">
Hides all of the annotations in the list
</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>annots</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="description last">Array of annotations to hide</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="importAnnotationCommand"><span class="type-signature"></span>importAnnotationCommand(xfdfString)</h4>
</dt>
<dd>
<div class="description">
Updates the viewer with the xfdf changes (add/modify/delete) in the xml string
</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>xfdfString</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The XML annotation updates as a string</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A promise that resolves to the list of annotations that were updated
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>>></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="importAnnotations"><span class="type-signature"></span>importAnnotations(xfdfString [, options])</h4>
</dt>
<dd>
<div class="description">
Loads XFDF annotations 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>xfdfString</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last">The XFDF annotations as a string</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">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>Argument</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="attributes">
<optional><br>
</td>
<td class="description last">The number of annotations to import in each batch (default 100)</td>
</tr>
<tr>
<td class="name"><code>batchDelay</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The amount of time in milliseconds to delay between importing each batch (default 0)</td>
</tr>
<tr>
<td class="name"><code>replace</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
|
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The type of existing annotations that will be removed before import starts (default [])</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns a promise that resolves with the annotations have been imported
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<any></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="importAnnotCommand"><span class="type-signature"></span>importAnnotCommand(xfdfString)</h4>
</dt>
<dd>
<div class="description">
Updates the viewer with the xfdf changes (add/modify/delete) in the xml string
</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>xfdfString</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The XML annotation updates as a string</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.
Please use <a href="Core.AnnotationManager.html#importAnnotationCommand">importAnnotationCommand</a> instead</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A promise that resolves to the list of annotations that were updated
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>>></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="isAnnotationRedactable"><span class="type-signature"></span>isAnnotationRedactable(annotation)</h4>
</dt>
<dd>
<div class="description">
Check if an annotation is redactable (is a redaction annotation the user can apply).
When using Webviewer Server, single redaction aren't allowed, only redact all is allowed
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">An annotation to check if it redactable</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if annotation can be redacted (WebViewer is set up correctly for applying), false otherwise
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="isAnnotationSelected"><span class="type-signature"></span>isAnnotationSelected(annotation)</h4>
</dt>
<dd>
<div class="description">
Returns whether an annotation is currently selected
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">An instance of Annotation.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if annotation is selected, false otherwise
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="isApplyRedactionEnabled"><span class="type-signature"></span>isApplyRedactionEnabled()</h4>
</dt>
<dd>
<div class="description">
Check if applying redaction is enabled
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if applying redactions 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="isCreateRedactionEnabled"><span class="type-signature"></span>isCreateRedactionEnabled()</h4>
</dt>
<dd>
<div class="description">
Check if creating redaction is enabled
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if creating redactions 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="isDraggingAcrossPagesEnabled"><span class="type-signature"></span>isDraggingAcrossPagesEnabled()</h4>
</dt>
<dd>
<div class="description">
Check if dragging annotations across pages is enabled.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if dragging annotations across pages 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="isFreeformRotationEnabled"><span class="type-signature"></span>isFreeformRotationEnabled()</h4>
</dt>
<dd>
<div class="description">
Returns whether freeform rotation is enabled for annotations.
</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.2
Please use getRotationOptions instead</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if freeform rotation 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="isFreeTextEditingEnabled"><span class="type-signature"></span>isFreeTextEditingEnabled()</h4>
</dt>
<dd>
<div class="description">
Returns whether free text editing is enabled directly on the annotation.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if free text editing 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="isReadOnlyModeEnabled"><span class="type-signature"></span>isReadOnlyModeEnabled()</h4>
</dt>
<dd>
<div class="description">
Returns whether the viewer is currently in read-only mode.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if the current viewer is in read-only mode, false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="isUserAdmin"><span class="type-signature"></span>isUserAdmin()</h4>
</dt>
<dd>
<div class="description">
Returns whether the current user has admin privileges.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if the current user is an admin, false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="jumpToAnnotation"><span class="type-signature"></span>jumpToAnnotation(annotation [, options])</h4>
</dt>
<dd>
<div class="description">
Jumps to the page of the annotation and if it isn't visible then centers it in the window.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">The annotation to be jumped to.</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 settings for jump behaiour. Default will guarantee the annotation will be on the screen at the current zoom level.
<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>horizontalOffset</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
auto
</td>
<td class="description last">Percentage of the screen the annotation will jump to, '0%' being the left of the page. Anything over '100%' and under '0%' will be off the page.</td>
</tr>
<tr>
<td class="name"><code>verticalOffset</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
auto
</td>
<td class="description last">Percentage of the screen the annotation will jump to, '0%' being the top of the page. Anything over '100%' and under '0%' will be off the page.</td>
</tr>
<tr>
<td class="name"><code>zoom</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
1
</td>
<td class="description last">The level of zoom, 1 being 100% zoom.</td>
</tr>
<tr>
<td class="name"><code>fitToView</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">If set to true the zoom will fit the entire annotation within the viewport.</td>
</tr>
<tr>
<td class="name"><code>isSmoothScroll</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">If set to true, the viewer will scroll to the annotation in a smooth way.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</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="pasteCopiedAnnotations"><span class="type-signature"></span>pasteCopiedAnnotations( [useMouseLocation])</h4>
</dt>
<dd>
<div class="description">
Pastes the currently copied annotations.
</div>
<h5>Parameters:</h5>
<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>useMouseLocation</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">Whether or not to paste the
annotations based on the position of the mouse cursor in the window,
accounting for the scroll position</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="promoteUserToAdmin"><span class="type-signature"></span>promoteUserToAdmin()</h4>
</dt>
<dd>
<div class="description">
Promote the current user to be an admin user. Admin users can edit any annotations.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="redrawAnnotation"><span class="type-signature"></span>redrawAnnotation(annotation)</h4>
</dt>
<dd>
<div class="description">
Redraws the specified annotation.
Note that the entire annotation canvas for the page will be redrawn.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation to be redrawn.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="registerAnnotationType"><span class="type-signature"></span>registerAnnotationType(elementName, annotationClass)</h4>
</dt>
<dd>
<div class="description">
Registers an annotation class. Annotations that are registered will be serialized and deserialized by the AnnotationManager.
</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>elementName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the string representing the xml element name of the annotation</td>
</tr>
<tr>
<td class="name"><code>annotationClass</code></td>
<td class="type">
<span class="param-type">Class.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="description last">the class (constructor) of the annotation</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if registration was successful
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</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="selectAnnotation"><span class="type-signature"></span>selectAnnotation(annotation)</h4>
</dt>
<dd>
<div class="description">
Selects the specified annotation.
If an annotation is successfully selected then the annotationSelected event will be fired with a "selected" action.
Note: the annotationSelected event has two parameters: an array of annotations and a string value of either "selected" or "deselected"
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">An instance of Annotation.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="selectAnnotations"><span class="type-signature"></span>selectAnnotations(annotations)</h4>
</dt>
<dd>
<div class="description">
Selects the specified annotations.
If an annotation is successfully selected then the annotationSelected event will be fired with a "selected" action.
Note: the annotationSelected event has two parameters: an array of annotations and a string value of either "selected" or "deselected"
</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>annotations</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="description last">An array of Annotations.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setAnnotationCanvasTransform"><span class="type-signature"></span>setAnnotationCanvasTransform(annotCanvasContext, zoom, rotation)</h4>
</dt>
<dd>
<div class="description">
Set the page transform of an annotation canvas
</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>annotCanvasContext</code></td>
<td class="type">
<span class="param-type">CanvasRenderingContext2D</span>
</td>
<td class="description last">Annotation canvas context to draw on</td>
</tr>
<tr>
<td class="name"><code>zoom</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The zoom or the scaling of the page canvas</td>
</tr>
<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="description last">The rotation of the page canvas</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setAnnotationDisplayAuthorMap"><span class="type-signature"></span>setAnnotationDisplayAuthorMap(mapFunction)</h4>
</dt>
<dd>
<div class="description">
Sets the mapping function used to get the display name for annotation authors
and is used when calling getDisplayAuthor.
</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>mapFunction</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">The mapping function to use. The function is passed a userID/GUID and should return the display name for the UI.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">annotManager.setAnnotationDisplayAuthorMap((annotationUserId) => {
if (annotationUserId === '1') {
return 'John';
} else {
return 'Guest';
}
});</pre>
</dd>
<hr>
<dt>
<h4 class="name" id="setAnnotationRichTextStyle"><span class="type-signature"></span>setAnnotationRichTextStyle(annotation, style)</h4>
</dt>
<dd>
<div class="description">
Sets the rich text style for the specified annotation
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation that will have its rich text style updated.</td>
</tr>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html#.RichTextStyle">Core.Annotations.Annotation.RichTextStyle</a></span>
</td>
<td class="description last">The object to update the rich text style to.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setAnnotationStyles"><span class="type-signature"></span>setAnnotationStyles(annotation, newStyles)</h4>
</dt>
<dd>
<div class="description">
Set the styles for the annotation
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">an annotation of which the styles will be changed.</td>
</tr>
<tr>
<td class="name"><code>newStyles</code></td>
<td class="type">
<span class="param-type">object</span>
|
<span class="param-type">function</span>
</td>
<td class="description last">if an object is used, it should contain properties of the new styles.
If a function is used, the current styles will be passed as its argument and the function should return an object which contains properties of the new styles.
Example of valid properties: StrokeColor, TextColor, FillColor, FontSize, Opacity, StrokeThickness, Precision, Scale, OverlayText, Style and Dashes.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setBeforeSubmitFormActionCallback"><span class="type-signature"></span>setBeforeSubmitFormActionCallback(callback)</h4>
</dt>
<dd>
<div class="description">
Sets the function to be called before a submit form action is triggered.
IMPORTANT: If either no value or a falsy value is returned from the callback,
then the submitForm API will be cancelled. Please ensure your callback
function returns the boolean true in order for the submit form action to
complete
</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"><a href="Core.AnnotationManager.html#.setBeforeSubmitFormActionCallbackFunction">Core.AnnotationManager.setBeforeSubmitFormActionCallbackFunction</a></span>
</td>
<td class="description last">The function that will be called prior to
invocation of the SubmitForm API.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setCurrentUser"><span class="type-signature"></span>setCurrentUser(user)</h4>
</dt>
<dd>
<div class="description">
Sets the current user of 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>user</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the user name of the current user.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setCustomAppearanceHandler"><span class="type-signature"></span>setCustomAppearanceHandler(func)</h4>
</dt>
<dd>
<div class="description">
Used to load appearance documents for annotations with custom appearances.
The function will be called when an annotation is imported that contains a custom appearance that references a filename.
</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>func</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">Function which must return Document object created with <a href="Core.html#.createDocument">Core.createDocument</a></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setFreeformRotationEnabled"><span class="type-signature"></span>setFreeformRotationEnabled(freeformRotationEnabled)</h4>
</dt>
<dd>
<div class="description">
Sets whether the annotations will have freeform rotation 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>freeformRotationEnabled</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">true if freeform rotation should be enabled, false otherwise.</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 setRotationOptions instead</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setIsAdminUser"><span class="type-signature"></span>setIsAdminUser(isAdminUser)</h4>
</dt>
<dd>
<div class="description">
Sets whether the current user is an admin user.
</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>isAdminUser</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">true if the current user is an admin, false otherwise.</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 promoteUserToAdmin or demoteUserFromAdmin instead</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setNoteContents"><span class="type-signature"></span>setNoteContents(annotation, text)</h4>
</dt>
<dd>
<div class="description">
Sets the value of the note for the specified annotation.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation that will have its note updated.</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 value to update the note text to.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setOldStickyNoteRenderingDate"><span class="type-signature"></span>setOldStickyNoteRenderingDate(date)</h4>
</dt>
<dd>
<div class="description">
Changes the sticky note rendering to the old implementation when the sticky note
has been created before the specified date.
</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>date</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The date timestamp to use</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setPermissionCheckCallback"><span class="type-signature"></span>setPermissionCheckCallback(callback)</h4>
</dt>
<dd>
<div class="description">
Sets the function that should be used to determine if the annotation can be modified or not.
</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">The function that should be called. Should return true or false.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setReadOnly"><span class="type-signature"></span>setReadOnly(readOnly)</h4>
</dt>
<dd>
<div class="description">
Sets whether the viewer is currently in read-only mode.
</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>readOnly</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">true if the viewer is in read-only mode, false otherwise.</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 enableReadOnlyMode or disableReadOnlyMode instead</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setRedrawThrottle"><span class="type-signature"></span>setRedrawThrottle(value)</h4>
</dt>
<dd>
<div class="description">
Sets the rate at which the redrawing of annotations is throttled. This can improve
annotation rendering on lower quality devices and browsers.
</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>value</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The throttled rate at which annotations will be redrawn, in milliseconds</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. Use <a href="Core.AnnotationManager.html#setRedrawThrottleRate">setRedrawThrottleRate</a> instead.</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setRedrawThrottleRate"><span class="type-signature"></span>setRedrawThrottleRate(value)</h4>
</dt>
<dd>
<div class="description">
Sets the rate at which the redrawing of annotations is throttled. This can improve
annotation rendering on lower quality devices and browsers.
</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>value</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The throttled rate at which annotations will be redrawn, in milliseconds</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setRotationOptions"><span class="type-signature"></span>setRotationOptions(options)</h4>
</dt>
<dd>
<div class="description">
Sets the rotation options for 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>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">An object that can contain the following 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>isEnabled</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Whether rotations are enabled or not.</td>
</tr>
<tr>
<td class="name"><code>hotkeyTogglesRotationType</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Determines if rotation type performed is toggled when holding down shift key.</td>
</tr>
<tr>
<td class="name"><code>defaultRotationType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Determines which rotation type will be performed without holding shift key.</td>
</tr>
<tr>
<td class="name"><code>snapAngleStepSizeInDegrees</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The angle (in degrees) applied to each snap rotation. Valid range is between 0 and 180.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">// Enables snap rotations at 60 degree steps, without having to hold shift key.
// Hotkey will not toggle rotation type (ie, freeform rotations are disabled).
const { Core } = instance;
const annotManager = Core.documentViewer.getAnnotationManager();
annotManager.setRotationOptions({
isEnabled: true,
defaultRotationType: Core.AnnotationManager.RotationTypes.SNAP_ROTATION,
hotkeyTogglesRotationType: false,
snapAngleStepSizeInDegrees: 60
});</pre>
</dd>
<hr>
<dt>
<h4 class="name" id="setSnapDefaultOptions"><span class="type-signature"></span>setSnapDefaultOptions(options)</h4>
</dt>
<dd>
<div class="description">
Set the snap options for annotation tool snapping
</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"><a href="Core.AnnotationManager.html#.snapDefaultOptions">Core.AnnotationManager.snapDefaultOptions</a></span>
</td>
<td class="description last">The snap mode options.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="setSubmitFormActionCallback"><span class="type-signature"></span>setSubmitFormActionCallback(callback)</h4>
</dt>
<dd>
<div class="description">
Sets the function to be called when a submit form action is triggered.
</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">The function that should be called. Will be passed the form data.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="showAnnotation"><span class="type-signature"></span>showAnnotation(annot)</h4>
</dt>
<dd>
<div class="description">
Shows the annotation
</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>annot</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation to show</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="showAnnotations"><span class="type-signature"></span>showAnnotations(annots)</h4>
</dt>
<dd>
<div class="description">
Shows all of the annotations in the list
</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>annots</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="description last">Array of annotations to show</td>
</tr>
</tbody>
</table>
<dl class="details">
</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="ungroupAnnotations"><span class="type-signature"></span>ungroupAnnotations(annotations)</h4>
</dt>
<dd>
<div class="description">
Ungroups an array of annotations
</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>annotations</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="description last">The array of annotations to ungroup.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="updateAnnotation"><span class="type-signature"></span>updateAnnotation(annotation)</h4>
</dt>
<dd>
<div class="description">
Redraws the annotations on the same page as the specified annotation if the annotation has been added.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">An instance of Annotation.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="updateAnnotationRichTextStyle"><span class="type-signature"></span>updateAnnotationRichTextStyle(annotation, style [, start] [, end])</h4>
</dt>
<dd>
<div class="description">
Update the rich text style for the specified annotation
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="attributes">
</td>
<td class="description last">The annotation that will have its rich text style updated.</td>
</tr>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type">Core.Annotations.Annotation.StyleObject</span>
</td>
<td class="attributes">
</td>
<td class="description last">The object to update the rich text style to.
<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>'underline'</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">boolean value for whether string should be underlined</td>
</tr>
<tr>
<td class="name"><code>'line-through'</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">boolean value for whether string should be strike through</td>
</tr>
<tr>
<td class="name"><code>'font-weight'</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">String for the font weight of the rich text (can be 'bold')</td>
</tr>
<tr>
<td class="name"><code>'font-style'</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">String for font style of the rich text (can be 'italic')</td>
</tr>
<tr>
<td class="name"><code>'color'</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">string for what color to set text to</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>start</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Optional starting index to apply the style, if not set, will start at 0</td>
</tr>
<tr>
<td class="name"><code>end</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Optional ending index for the style, if not set, will apply style to end of text</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="updateAnnotationState"><span class="type-signature"></span>updateAnnotationState(annotation, state, stateModel, message)</h4>
</dt>
<dd>
<div class="description">
Updates the annotation state. This is done by creating an annotation that replies to the passed in annotation.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation to add a reply to</td>
</tr>
<tr>
<td class="name"><code>state</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Annotations may have an author-specific state associated with them.
Valid states are for Review stateModel: Accepted, Rejected, Cancelled, Completed, None. Default is None.
Valid states are for Marked stateModel: Marked and Unmarked. Default is Unmarked.</td>
</tr>
<tr>
<td class="name"><code>stateModel</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Gets or sets the stateModel of the annotation. stateModel has two statemodels: Marked, Review. Default is Review.</td>
</tr>
<tr>
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Message to be set when the state is updated.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The created annotation reply
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Core.Annotations.StickyAnnotation.html">Core.Annotations.StickyAnnotation</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="updateCopiedAnnotations"><span class="type-signature"></span>updateCopiedAnnotations()</h4>
</dt>
<dd>
<div class="description">
Copies the currently selected annotations.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="useFreeTextEditing"><span class="type-signature"></span>useFreeTextEditing()</h4>
</dt>
<dd>
<div class="description">
Returns whether free text editing is enabled directly on the annotation.
</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.AnnotationManager.html#isFreeTextEditingEnabled">isFreeTextEditingEnabled</a> instead.</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if free text editing is enabled, false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<dl>
<hr>
<dt class="name" id=".AnnotationChangedInfoObject">
<h4 id=".AnnotationChangedInfoObject">AnnotationChangedInfoObject</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>imported</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">A boolean that will be true if the annotation change is the result of importing annotations using importAnnotations, importAnnotationCommand or if the imported parameter is set to true when calling addAnnotations or deleteAnnotations</td>
</tr>
<tr>
<td class="name"><code>isUndoRedo</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">A boolean that will be true if the annotation change is the result of an undo or redo action</td>
</tr>
<tr>
<td class="name"><code>source</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">An optional string that indicates what type of action caused this event (i.e. "redactionApplied")</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".RedactionInfo">
<h4 id=".RedactionInfo">RedactionInfo</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>pageNumber</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page number of the redaction</td>
</tr>
<tr>
<td class="name"><code>rect</code></td>
<td class="type">
<span class="param-type"><a href="Core.Math.Rect.html">Core.Math.Rect</a></span>
</td>
<td class="description last">A rect containing the bounding box of the redaction</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setBeforeSubmitFormActionCallbackFunction"><span class="type-signature"></span>setBeforeSubmitFormActionCallbackFunction(submitFormParams)</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>submitFormParams</code></td>
<td class="type">
<span class="param-type"><a href="Core.AnnotationManager.html#.SubmitFormParams">Core.AnnotationManager.SubmitFormParams</a></span>
</td>
<td class="description last">An object corresponding to the
parameters passed when the submitForm API was invoked</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt class="name" id=".snapDefaultOptions">
<h4 id=".snapDefaultOptions">snapDefaultOptions</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>radiusThreshold</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The distance threshold in pixel for snap feature to be effective.</td>
</tr>
<tr>
<td class="name"><code>indicatorSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The side length in pixels of the snap indicator's bounding square.</td>
</tr>
<tr>
<td class="name"><code>indicatorColor</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The color of the snap indicator. Accepts CSS HEX or CSS RGBA value.</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".SubmitFormParams">
<h4 id=".SubmitFormParams">SubmitFormParams</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>fields</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">An array of field names to submit</td>
</tr>
<tr>
<td class="name"><code>empty</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">If true, submit all fields, including those that
have no value. If false, exclude fields that currently have no value</td>
</tr>
<tr>
<td class="name"><code>fdf</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">If true, form data is submitted as FDF. If false,
it is submitted as XFDF</td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The URL to submit the form data to</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Events</h3>
<dl>
<hr>
<dt>
<h4 class="name" id="event:addReply">addReply</h4>
</dt>
<dd>
<div class="description">
Triggered when a reply has been added to an annotation
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation that was added</td>
</tr>
<tr>
<td class="name"><code>parent</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation that is the direct parent of the first annotation</td>
</tr>
<tr>
<td class="name"><code>root</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation that is the root parent of the first annotation (may be the same as parent)</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:annotationChanged">annotationChanged</h4>
</dt>
<dd>
<div class="description">
Triggered when an annotation or annotations have been changed (added, deleted, modified).
Attach like annotManager.addEventListener('annotationChanged', 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>annotations</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="description last">The annotations that were changed</td>
</tr>
<tr>
<td class="name"><code>action</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The action that occurred (add, delete, modify)</td>
</tr>
<tr>
<td class="name"><code>info</code></td>
<td class="type">
<span class="param-type"><a href="Core.AnnotationManager.html#.AnnotationChangedInfoObject">Core.AnnotationManager.AnnotationChangedInfoObject</a></span>
</td>
<td class="description last">An object containing extra information about the annotationChanged event</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:annotationDeselected">annotationDeselected</h4>
</dt>
<dd>
<div class="description">
Triggered after annotations have been deselected.
</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>annotationList</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="description last">List of annotations that have been deselected.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:annotationDoubleClicked">annotationDoubleClicked</h4>
</dt>
<dd>
<div class="description">
Triggered after an annotation has been double clicked
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation that has been double clicked</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:annotationHidden">annotationHidden</h4>
</dt>
<dd>
<div class="description">
Triggered after annotations have been hidden/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>annotationList</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="description last">List of annotations that were hidden or shown</td>
</tr>
<tr>
<td class="name"><code>hidden</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether the annotations have been hidden or shown</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:annotationsDrawn">annotationsDrawn</h4>
</dt>
<dd>
<div class="description">
Triggered after annotations have been drawn for a 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">object</span>
</td>
<td class="description last">The page number of all the annotations that were just drawn</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:annotationSelected">annotationSelected</h4>
</dt>
<dd>
<div class="description">
Triggered after annotation selection has been 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>annotationList</code></td>
<td class="type">
<span class="param-type">Array.<<a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a>></span>
</td>
<td class="description last">List of annotations that have selected or deselected.</td>
</tr>
<tr>
<td class="name"><code>action</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Either 'selected' or 'deselected'</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:deleteReply">deleteReply</h4>
</dt>
<dd>
<div class="description">
Triggered when a reply has been deleted from an annotation
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation that was deleted</td>
</tr>
<tr>
<td class="name"><code>root</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation that is the root parent of the first annotation</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:fieldChanged">fieldChanged</h4>
</dt>
<dd>
<div class="description">
Triggered when a field's value has been changed.
Attach like annotManager.addEventListener('fieldChanged', 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>field</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The field that was changed</td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The field's new value</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:fileAttachmentDataAvailable">fileAttachmentDataAvailable</h4>
</dt>
<dd>
<div class="description">
Triggered after the file attachment data is available after double clicking on the annotation
</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>fileInfo</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Information of the file attachment
<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>fileData</code></td>
<td class="type">
<span class="param-type">Blob</span>
</td>
<td class="description last">The blob data of the file attachment</td>
</tr>
<tr>
<td class="name"><code>filename</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The name of the file attachment</td>
</tr>
<tr>
<td class="name"><code>mimeType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The mimetype attribute of the file attachment</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:setNoteText">setNoteText</h4>
</dt>
<dd>
<div class="description">
Triggered when the text should be set on a note
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation that needs to have its note text updated</td>
</tr>
<tr>
<td class="name"><code>root</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="description last">The annotation that is the root parent of the first annotation</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="event:updateAnnotationPermission">updateAnnotationPermission</h4>
</dt>
<dd>
<div class="description">
Triggered when permissions for annotations should be updated. This might be when the user changes or readonly is switched to.
If no annotation is specified then every annotation should be updated.
</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>annotation</code></td>
<td class="type">
<span class="param-type"><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The annotation that needs to have its permissions updated</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:41-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>