%PDF-1.4 %Óëéá 1 0 obj <> endobj 3 0 obj <> endobj 4 0 obj < AnonSec Shell
AnonSec Shell
Server IP : 212.252.79.165  /  Your IP : 216.73.216.226   [ Reverse IP ]
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/public_html/pdfjs/doc/

Upload File :
current_dir [ Writeable ] document_root [ Writeable ]

 

Command :

[ HOME ]     [ BACKUP SHELL ]     [ JUMPING ]     [ MASS DEFACE ]     [ SCAN ROOT ]     [ SYMLINK ]     

Current File : /home/cehaburo/public_html/pdfjs/doc/quicksearch.html
<html>
<head>
</head>
<body style="background: transparent;">
    <script src="scripts/docstrap.lib.js"></script>
    <script src="scripts/lunr.min.js"></script>
    <script src="scripts/fulltext-search.js"></script>

    <script type="text/x-docstrap-searchdb">
    {"global.html":{"id":"global.html","title":"Global","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Global Methods getInstance( [element]) Gets an already existing instance of WebViewer. If only one instance of WebViewer exists on the page, then 'element' is not required, and the function will return the instance of WebViewer. If more than one instance of WebViewer exists, you must pass in the DOM element containing the instance of WebViewer you want to retrieve. This function can be imported directly as a module as well. Parameters: Name Type Argument Description element HTMLElement &lt;optional&gt; The DOM element containing the instance of WebViewer you want to retrieve Returns: Returns an instance of WebViewer. Returns null if no instances are available. Type WebViewerInstance Example import { getInstance } from '@pdftron/webviewer' // After WebViewer has already been constructed const instance = getInstance(); WebViewer(options, viewerElement) A function that creates an instance of WebViewer, and embeds it on the HTML page Parameters: Name Type Description options WebViewerOptions viewerElement HTMLElement Properties: Name Type Description WorkerTypes WorkerTypes The types of workers that can be preloaded in WebViewer BackendTypes BackendTypes The types of backend workers. Returns: A promise resolved with WebViewer instance. Type Promise.&lt;WebViewerInstance&gt; Example WebViewer({ licenseKey: 'Insert commercial license key here after purchase' }, document.getElementById('viewer')) .then(function(instance) { const documentViewer = instance.Core.documentViewer; const annotationManager = instance.Core.annotationManager; // call methods from instance, documentViewer and annotationManager as needed // you can also access major namespaces from the instances as follows: // const Tools = instance.Core.Tools; // const Annotations = instance.Core.Annotations; }); Type Definitions BackendTypes The types of backend workers. Pass \"asm\" to force the use of the ASM.js worker, \"ems\" to force the use of the WebAssembly worker (or ASM.js on non-wasm browsers) or \"wasm-threads\" to use threaded WebAssembly. Properties: Name Type Description ASM string 'asm' Use of ASM.js worker. WASM string 'ems' Use of the WebAssembly worker (or ASM.js on non-wasm browsers). THREADED_WASM string 'wasm-threads' Use of threaded WebAssembly worker. WebViewerOptions Type: Object Properties: Name Type Argument Default Description path string Path to the WebViewer lib folder annotationUser string &lt;optional&gt; Guest Name of the user for annotations config string &lt;optional&gt; URL path to a custom JavaScript for customizations css string &lt;optional&gt; URL path to a custom CSS file for customizations disabledElements Array.&lt;string&gt; &lt;optional&gt; List of data-elements to be disabled in UI accessibleMode boolean &lt;optional&gt; false Enable accessibility features. E.g tab page selection and page text in the DOM enableAnnotations boolean &lt;optional&gt; true Enable annotations feature enableFilePicker boolean &lt;optional&gt; false Enable file picker feature enableMeasurement boolean &lt;optional&gt; false Enable measurement tools enableRedaction boolean &lt;optional&gt; false Enable redaction tool disableVirtualDisplayMode boolean &lt;optional&gt; false Disable virtual display mode for pages. The virtual display mode allows documents with many pages to be loaded efficiently in continuous scrolling mode. If disabled then single page mode will be used for documents with many pages. extension string &lt;optional&gt; Extension of the document to be loaded filename string &lt;optional&gt; The name of the file that will be used when downloading the document. The extension in the filename will be used as the document type to be loaded (e.g. myfile.docx will treat the file as docx) if no extension option is passed. initialDoc string &lt;optional&gt; URL path to a document to load on startup isAdminUser boolean &lt;optional&gt; false Set user permission to admin isReadOnly boolean &lt;optional&gt; false Set user permission to read-only licenseKey string &lt;optional&gt; License key for viewing documents. If not set then WebViewer will be in demo mode. ui string &lt;optional&gt; default Type of UI to be used. Accepts `default`|`beta`. disableLogs boolean &lt;optional&gt; false Disables console logs coming from WebViewer, including the version and build numbers disableFlattenedAnnotations boolean &lt;optional&gt; false Disables the flattened rendering of existing annotations in documents. uiPath string &lt;optional&gt; Path to UI folder to use a different UI or customized UI. Default is'./ui/index.html'. selectAnnotationOnCreation boolean &lt;optional&gt; false If true then newly added annotations will be selected automatically highContrastMode boolean &lt;optional&gt; false If true then the UI will use high constrast colours to help with accessibility. WorkerTypes Used to preload workers before a document has been loaded. Properties: Name Type Description PDF string To preload the PDF worker object OFFICE string To preload the Office worker object LEGACY_OFFICE string To preload the Legacy Office worker object CONTENT_EDIT string To preload the content edit worker object ALL string To preload all the workers objects Example WebViewer({ preloadWorker: `${WebViewer.WorkerTypes.PDF},${WebViewer.WorkerTypes.OFFICE}` }) .then(function(instance) { ... }); zoomStepFactor Set the zoom step size for zooming in/out. Type: Object Properties: Name Type Description zoomStepFactor.step number zoom step size in %, should always be positive zoomStepFactor.startZoom number zoom level that the zoom step size start to apply, should always be positive. Example WebViewer(...) .then(function(instance) { const documentViewer = instance.Core.documentViewer; // you must have a document loaded when calling this api documentViewer.addEventListener('documentLoaded', function() { instance.UI.setZoomStepFactors([ { step: 50, startZoom: 0 } ]); }); }); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:40-07:00 using the DocStrap template. "},"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Classes Classes Action Dest GoTo GoToR Hide JavaScript Named ResetForm SubmitForm URI AnnotationHistoryManager AnnotationManager Annotation ArcAnnotation Border BoxControlHandle BoxSelectionModel ButtonWidgetAnnotation CalloutControlHandle CalloutSelectionModel CanvasHelper CaretAnnotation CheckButtonWidgetAnnotation ChoiceWidgetAnnotation Color ControlHandle CustomAnnotation DatePickerWidgetAnnotation EllipseAnnotation FileAttachmentAnnotation Font Forms EmbeddedJS Field FieldManager FreeHandAnnotation FreeTextAnnotation RichTextEditor FreeTextSelectionModel HTMLAnnotation IPathAnnotation LineAnnotation LineControlHandle LineSelectionModel Link ListWidgetAnnotation MarkupAnnotation Model3D PathControlHandle PathSelectionModel PolygonAnnotation PolygonControlHandle PolygonSelectionModel PolylineAnnotation PopupAnnotation RadioButtonWidgetAnnotation RectangleAnnotation RedactionAnnotation RedactionSelectionModel RotationControlHandle RotationUtils SelectionAlgorithm SelectionModel SignatureWidgetAnnotation SoundAnnotation StampAnnotation StickyAnnotation TextHighlightAnnotation TextMarkupAnnotation TextRedactAnnotation TextSelectionModel TextSquigglyAnnotation TextStrikeoutAnnotation TextUnderlineAnnotation TextWidgetAnnotation WidgetAnnotation WidgetFlags XFDFUtils Bookmark DisplayMode DisplayModeManager Document DocumentViewer EditBoxManager EventHandler Matrix Point Quad Rect TransformationBuilder MeasurementManager PartRetriever Scale AnnotationEditTool AnnotationSelectTool ArcCreateTool ArcMeasurementCreateTool AreaMeasurementCreateTool ArrowCreateTool CalloutCreateTool ChangeViewCreateTool CheckBoxFormFieldCreateTool CloudyRectangularAreaMeasurementTool ComboBoxFormFieldCreateTool ContentEditTool CountMeasurementCreateTool DateFreeTextCreateTool DistanceMeasurementCreateTool EllipseCreateTool EllipseMeasurementCreateTool EraserTool FileAttachmentCreateTool FreeHandCreateTool FreeHandHighlightCreateTool FreeTextCreateTool GenericAnnotationCreateTool LineCreateTool ListBoxFormFieldCreateTool MarqueeZoomTool PageCoordinate PanTool PerimeterMeasurementCreateTool PolygonCloudCreateTool PolygonCreateTool PolylineCreateTool RadioButtonFormFieldCreateTool RectangleCreateTool RectangularAreaMeasurementTool RedactionCreateTool RubberStampCreateTool SignatureCreateTool StampCreateTool StickyCreateTool TextAnnotationCreateTool TextFormFieldCreateTool TextHighlightCreateTool TextSelectTool TextSquigglyCreateTool TextStrikeoutCreateTool TextTool TextUnderlineCreateTool Tool TextHighlightAnnotation Header MentionsManager WebViewerInstance Mixins Dispatcher Namespaces Core Actions Annotations ContentEdit Math PartRetrievers Search Tools UI Fonts Hotkeys NotesPanel TabManager ThumbnailsPanel VerificationOptions Events historyChanged Triggered when the annotation history stack changes. This could be used to check the canUndo or canRedo functions if their value has changed. addReply Triggered when a reply has been added to an annotation Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added parent Core.Annotations.Annotation The annotation that is the direct parent of the first annotation root Core.Annotations.Annotation The annotation that is the root parent of the first annotation (may be the same as parent) annotationChanged Triggered when an annotation or annotations have been changed (added, deleted, modified). Attach like annotManager.addEventListener('annotationChanged', callback) Parameters: Name Type Description annotations Array.&lt;Core.Annotations.Annotation&gt; The annotations that were changed action string The action that occurred (add, delete, modify) info Core.AnnotationManager.AnnotationChangedInfoObject An object containing extra information about the annotationChanged event annotationDeselected Triggered after annotations have been deselected. Parameters: Name Type Description annotationList Array.&lt;Core.Annotations.Annotation&gt; List of annotations that have been deselected. annotationDoubleClicked Triggered after an annotation has been double clicked Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that has been double clicked annotationHidden Triggered after annotations have been hidden/shown. Parameters: Name Type Description annotationList Array.&lt;Core.Annotations.Annotation&gt; List of annotations that were hidden or shown hidden boolean Whether the annotations have been hidden or shown annotationsDrawn Triggered after annotations have been drawn for a page Parameters: Name Type Description pageNumber object The page number of all the annotations that were just drawn annotationSelected Triggered after annotation selection has been changed. Parameters: Name Type Description annotationList Array.&lt;Core.Annotations.Annotation&gt; List of annotations that have selected or deselected. action string Either 'selected' or 'deselected' deleteReply Triggered when a reply has been deleted from an annotation Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was deleted root Core.Annotations.Annotation The annotation that is the root parent of the first annotation fieldChanged Triggered when a field's value has been changed. Attach like annotManager.addEventListener('fieldChanged', callback) Parameters: Name Type Description field object The field that was changed value string The field's new value fileAttachmentDataAvailable Triggered after the file attachment data is available after double clicking on the annotation Parameters: Name Type Description fileInfo object Information of the file attachment Properties Name Type Description fileData Blob The blob data of the file attachment filename string The name of the file attachment mimeType string The mimetype attribute of the file attachment setNoteText Triggered when the text should be set on a note Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that needs to have its note text updated root Core.Annotations.Annotation The annotation that is the root parent of the first annotation updateAnnotationPermission 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. Parameters: Name Type Argument Description annotation Core.Annotations.Annotation &lt;optional&gt; The annotation that needs to have its permissions updated calculate A signal that the field should fire its own calculation events. Parameters: Name Type Description source Core.Annotations.Forms.Field The field that caused the calculation event. Listeners of This Event: Core.Annotations.Forms.Field change An event that represents a field's value having changed. Parameters: Name Type Description field Core.Annotations.Forms.Field The field that has changed. commit The field's value has been changed by the user. Sets a new value. Parameters: Name Type Argument Description value string | number &lt;nullable&gt; The new field value. Listeners of This Event: Core.Annotations.Forms.Field editBoxesAvailable Triggered any time edit boxes are drawn on the page. Parameters: Name Type Description boxes object An array of Content Edit boxes. textContentUpdated Triggered when text content of the page is updated. Parameters: Name Type Description originalText string The original text of the selected bounding box. updatedText string The updated text of the selected bounding box. boundingBoxCoordinates object The coordinates (top, left, bottom, right) of the bounding box. colorSeparationAdded Triggered when a color separation is loaded and available on the document. Parameters: Name Type Description colorData object An object with properties of the color separation Properties Name Type Description name string The name of the color separation rgb Array.&lt;any&gt; An array containing the R, G and B values for the separation layersUpdated Triggered when a document's layers/OCG structures change visibility. Parameters: Name Type Description layerContext Array.&lt;Core.Document.LayerContext&gt; array of page layers activeSearchResultChanged Triggered when the active search result has changed Parameters: Name Type Description result object The new active search result, Core.DocumentViewer.SearchResult. annotationsLoaded Triggered when all the annotations embedded in the document have been loaded beforeDocumentLoaded Triggered just before the document has been loaded into the viewer beginRendering Triggered when DocumentViewer starts rendering pages click Triggered for the click event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event dblClick Triggered for the dblClick event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event displayModeUpdated Triggered when the display mode is updated displayPageLocation Triggered when a page location should be displayed Parameters: Name Type Description pageNum number The 1-indexed page number verticalOffset number The offset from the top of the page horizontalOffset number The offset from the left of the page documentLoaded Triggered when a new document has been loaded documentUnloaded Triggered when the current document has been closed and unloaded embeddedThumbnailComplete Triggered when an embedded thumbnail of a viewer-optimized pdf is completely loaded. Parameters: Name Type Description pageNum number The 1-indexed page number finishedRendering Triggered when DocumentViewer finishes rendering pages fitModeUpdated Triggered when the fit mode has changed Parameters: Name Type Description fitMode object The fit mode that has been changed to e.g. docViewer.FitMode.FitWidth keyDown Triggered for the keyDown event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event keyUp Triggered for the keyUp event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseEnter Triggered for the mouseEnter event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseLeave Triggered for the mouseLeave event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseLeftDown Triggered for the mouseLeftButtonDown event in the DocumentViewer's viewing area Attach like docViewer.addEventListener('mouseLeftDown', callback) Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseLeftUp Triggered for the mouseLeftButtonUp event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseMove Triggered for the mouseMove event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseRightDown Triggered for the mouseRightButtonDown event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseRightUp Triggered for the mouseRightButtonUp event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event notify Triggered when there is a notification relating to searching or annotation permissions. Parameters: Name Type Description type string The type of notification that has occurred pageComplete Triggered when a page has been completely rendered. Parameters: Name Type Description pageNum number The 1-indexed page number canvas HTMLCanvasElement The canvas for the page pageNumberUpdated Triggered when the page number is updated Parameters: Name Type Description pageNumber number The new page number (1-indexed) pagesUpdated Triggered when the layout has changed because pages have permanently been added, removed, moved or changed in some other way. Parameters: Name Type Description changes object An object with keys added, removed, moved and contentChanged, indicating which pages have changed rotationUpdated Triggered when the page rotation has changed Parameters: Name Type Argument Description rotation Core.PageRotation The new viewing rotation. pageNumber number &lt;optional&gt; Optionally the specific page number that had its rotation changed searchInProgress Triggered when a search starts or ends. When Core.DocumentViewer#clearSearchResults is executed searchInProgress event is triggered with both inProgress and isFullSearch arguments to be undefined. This can be used to differentiate the search that hasn’t been started versus the search that was done. Parameters: Name Type Description inProgress boolean Whether a search is in progress or not isFullSearch boolean Whether this is a full text search or not searchResultsChanged Triggered when the search results list has changed Parameters: Name Type Description results Array.&lt;object&gt; The new search results, Core.DocumentViewer.SearchResult. tap Triggered when there is a tap in the DocumentViewer's viewing area. Taps are defined as a mouse down and up within a short time period and within a short distance.a Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event textSelected Triggered when the selected text has changed Parameters: Name Type Description quads Array.&lt;Core.Math.Quad&gt; An array of bounding box quads of the selected text text string The selected text pageNumber number The page number that the text was selected on toolModeUpdated Triggered when the tool mode has changed Parameters: Name Type Description newToolObject object The tool object that has been changed to. oldToolObject object The tool object that has been changed from. toolUpdated Triggered when the tool styles or tool name have changed Parameters: Name Type Description toolModeClass object The tool object that has been changed. zoomUpdated Triggered when the zoom level has been updated Parameters: Name Type Description zoom number The new zoom level of the viewer editorBlur Triggered after an editor blurred Parameters: Name Type Description editor Core.Annotations.FreeTextAnnotation.RichTextEditor an instance of Editor annotation Core.Annotations.FreeTextAnnotation a freetext annotation editorFocus Triggered after an editor is focused Parameters: Name Type Description editor Core.Annotations.FreeTextAnnotation.RichTextEditor an instance of Editor annotation Core.Annotations.FreeTextAnnotation a freetext annotation editorSelectionChanged Triggered after selection in the editor changed Parameters: Name Type Description range Core.EditBoxManager.Range current selected range oldRange Core.EditBoxManager.Range previous selected range editorTextChanged Triggered after some text in the editor changed scaleUpdated Triggered when the scale has been updated. Parameters: Name Type Description result object All the scales with related annotations annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolylineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolylineCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.ArcCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.ArcCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PerimeterMeasurementCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PerimeterMeasurementCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.LineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.LineCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolylineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolylineCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangleCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangleCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangularAreaMeasurementTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangularAreaMeasurementTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangleCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangleCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.StickyCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.StickyCreateTool#event:annotationCreated cropApplied Fired when a crop is performed on the document Parameters: Name Type Description cropInfo Object Properties Name Type Description pageNumber number The page number the crop was applied on left number The number of points (pts) cut off the left edge right number The number of points (pts) cut off the right edge bottom number The number of points (pts) cut off the bottom edge top number The number of points (pts) cut off the top edge annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.FreeTextCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.FreeTextCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.LineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.LineCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.EllipseCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.EllipseCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated erasingAnnotation Triggered when an annotation is about to be deleted from the document by the tool Parameters: Name Type Description args object Event arguments with event related properties Properties Name Type Description annotation The annotation that will be deleted skipAnnotation Core.Annotations.FreeHandAnnotation A function you can call to skip deleting the annotation or points from a Example const eraserTool = docViewer.getTool('AnnotationEraserTool'); eraserTool.addEventListener('erasingAnnotation', function(args) { // Make eraser tool skip deleting rectangle annotations if (args.annotation instanceof Annotations.RectangleAnnotation) { args.skipAnnotation(); } }); annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.FreeHandCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.FreeHandCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangleCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangleCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolylineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolylineCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolygonCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolygonCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolylineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolylineCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.EllipseCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.EllipseCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.AreaMeasurementCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.AreaMeasurementCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.StampAnnotation The annotation that was added annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added fileRejected Triggered when a file has been rejected because of exceeding file size limit Parameters: Name Type Description reasons Object The rejection reasons object Properties Name Type Description reason string Reason why the file was rejected maxSize number Maximum accpted file size in bytes size number Uploaded file size in bytes locationSelected Triggered when a page location has been clicked on by the tool Parameters: Name Type Argument Description pageCoordinates Core.Tools.PageCoordinate Indicates where the tool clicked signatureWidget Core.Annotations.SignatureWidgetAnnotation &lt;optional&gt; The signature widget that was clicked to trigger the event signatureDeleted Triggered when the tool deletes a signature Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was deleted index number The index of the annotation in the list signatureSaved Triggered when the tool saves a signature Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was saved annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added fileRejected Triggered when a file has been rejected because of exceeding file size limit Parameters: Name Type Description reasons Object The rejection reasons object Properties Name Type Description reason string Reason why the file was rejected maxSize number Maximum accpted file size in bytes size number Uploaded file size in bytes fileRejected Triggered when a file has been rejected because of exceeding file size limit Parameters: Name Type Description reasons Object The rejection reasons object Properties Name Type Description reason string Reason why the file was rejected maxSize number Maximum accpted file size in bytes size number Uploaded file size in bytes annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangleCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangleCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated selectionComplete Triggered when the user has released the mouse after selecting text Parameters: Name Type Description startLocation object An object with keys \"quad\" and \"pageNumber\" which is the starting quad and page number of the text selection allQuads object An object with keys being the page numbers and values being an array of quads for the selected text on that page annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated mentionChanged Triggered when a mention or mentions have been changed (added, deleted, modified). Attach like instance.mentions.on('mentionChanged', callback) Parameters: Name Type Description mentions UI.MentionsManager.Mention The mentions that were changed action 'add' | 'modify' | 'delete' The action that occurred (add, delete, modify) annotationFilterChanged Triggered when annotation filter in the notes panel has changed. Returns empty arrays if the filter is cleared. Type: object Properties: Name Type Description types Array.&lt;string&gt; Types filter authors Array.&lt;string&gt; Author filter colors Array.&lt;string&gt; Color filter statuses Array.&lt;string&gt; Status filter beforeTabChanged Triggered before the UI switches tabs Type: object Properties: Name Type Description currentTab object An object containing the properties for the currently active tab (null if no currently active tab) Properties Name Type Description id number The id of the tab being switched to src string Source of current tab options string Tab load options annotationsChanged boolean True if the annotations have been changed since loading the tab nextTab object An object containing the properties for the tab being switched to Properties Name Type Description id number The id of the tab being switched to src string Source of current tab options string Tab load options documentLoaded Triggered when a new document has been loaded. documentMerged Triggered when a new document has been merged into the thumbnails panel. Type: object Properties: Name Type Description filename string File name pages Array.&lt;number&gt; Page numbers dragOutline Triggered when dragging Outline item. dragOutline Triggered when dropping Outline item. fileDownloaded Triggered when the file has finished downloading. finishedSavingPDF Deprecated: Since version 8.3. Use fileDownloaded instead fullscreenModeToggled Triggered when fullscreen mode is toggled. Type: object Properties: Name Type Description isInFullscreen boolean Whether in fullscreen mode or not. loaderror Triggered when there is an error loading the document. Parameters: Name Type Description err object The error outlineBookmarksChanged Triggered when outline bookmarks have changed. Parameters: Name Type Description bookmarkData object Properties Name Type Description bookmark object The changed bookmark Properties Name Type Description id string Changed outline bookmark id name string Changed outline bookmark name path string Changed outline path in the outline tree action string The action that triggered the outline bookmarks change panelResized Triggered when the panels are resized. Type: object Properties: Name Type Description element string DataElement name width number New panel width selectedThumbnailChanged Triggered when the selected thumbnail changed. Parameters: Name Type Description selectedThumbnailPageIndexes array The array of indexes of currently selected thumbnails tabAdded Triggered when a Tab is added Type: object Properties: Name Type Description id number The id of the tab being added src string Source of current tab options string Tab load options tabDeleted Triggered when a Tab is deleted Type: object Properties: Name Type Description id number The id of the tab being deleted src string Source of current tab options string Tab load options tabMoved Triggered when a Tab is moved Type: object Properties: Name Type Description id number The id of the tab being moved src string Source of moved tab options string Tab load options prevIndex number Previous index of tab newIndex number New index of tab themeChanged Triggered when the UI theme has changed. Parameters: Name Type Description theme string The new UI theme thumbnailDragged Triggered when thumbnail(s) are dragged in the thumbnail panel thumbnailDropped Triggered when dragged thumbnail(s) are dropped to a new location in the thumbnail panel Type: object Properties: Name Type Description pageNumbersBeforeMove Array.&lt;number&gt; The array of page numbers to be moved pageNumbersAfterMove Array.&lt;number&gt; The array of page numbers of where thumbnails being dropped numberOfPagesMoved number Number of page(s) being moved toolbarGroupChanged Triggered when the toolbar group has changed. Parameters: Name Type Description toolbarGroup string The new toolbar group userBookmarksChanged Triggered when user bookmarks have changed. Parameters: Name Type Description bookmarks object The new bookmarks viewerLoaded Triggered when the viewer has loaded. visibilityChanged Triggered when the visibility of an element has changed. Type: object Properties: Name Type Description element string DataElement name isVisible boolean The new visibility × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:40-07:00 using the DocStrap template. "},"namespaces.list.html":{"id":"namespaces.list.html","title":"Namespaces","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespaces Classes Action Dest GoTo GoToR Hide JavaScript Named ResetForm SubmitForm URI AnnotationHistoryManager AnnotationManager Annotation ArcAnnotation Border BoxControlHandle BoxSelectionModel ButtonWidgetAnnotation CalloutControlHandle CalloutSelectionModel CanvasHelper CaretAnnotation CheckButtonWidgetAnnotation ChoiceWidgetAnnotation Color ControlHandle CustomAnnotation DatePickerWidgetAnnotation EllipseAnnotation FileAttachmentAnnotation Font Forms EmbeddedJS Field FieldManager FreeHandAnnotation FreeTextAnnotation RichTextEditor FreeTextSelectionModel HTMLAnnotation IPathAnnotation LineAnnotation LineControlHandle LineSelectionModel Link ListWidgetAnnotation MarkupAnnotation Model3D PathControlHandle PathSelectionModel PolygonAnnotation PolygonControlHandle PolygonSelectionModel PolylineAnnotation PopupAnnotation RadioButtonWidgetAnnotation RectangleAnnotation RedactionAnnotation RedactionSelectionModel RotationControlHandle RotationUtils SelectionAlgorithm SelectionModel SignatureWidgetAnnotation SoundAnnotation StampAnnotation StickyAnnotation TextHighlightAnnotation TextMarkupAnnotation TextRedactAnnotation TextSelectionModel TextSquigglyAnnotation TextStrikeoutAnnotation TextUnderlineAnnotation TextWidgetAnnotation WidgetAnnotation WidgetFlags XFDFUtils Bookmark DisplayMode DisplayModeManager Document DocumentViewer EditBoxManager EventHandler Matrix Point Quad Rect TransformationBuilder MeasurementManager PartRetriever Scale AnnotationEditTool AnnotationSelectTool ArcCreateTool ArcMeasurementCreateTool AreaMeasurementCreateTool ArrowCreateTool CalloutCreateTool ChangeViewCreateTool CheckBoxFormFieldCreateTool CloudyRectangularAreaMeasurementTool ComboBoxFormFieldCreateTool ContentEditTool CountMeasurementCreateTool DateFreeTextCreateTool DistanceMeasurementCreateTool EllipseCreateTool EllipseMeasurementCreateTool EraserTool FileAttachmentCreateTool FreeHandCreateTool FreeHandHighlightCreateTool FreeTextCreateTool GenericAnnotationCreateTool LineCreateTool ListBoxFormFieldCreateTool MarqueeZoomTool PageCoordinate PanTool PerimeterMeasurementCreateTool PolygonCloudCreateTool PolygonCreateTool PolylineCreateTool RadioButtonFormFieldCreateTool RectangleCreateTool RectangularAreaMeasurementTool RedactionCreateTool RubberStampCreateTool SignatureCreateTool StampCreateTool StickyCreateTool TextAnnotationCreateTool TextFormFieldCreateTool TextHighlightCreateTool TextSelectTool TextSquigglyCreateTool TextStrikeoutCreateTool TextTool TextUnderlineCreateTool Tool TextHighlightAnnotation Header MentionsManager WebViewerInstance Mixins Dispatcher Namespaces Core Actions Annotations ContentEdit Math PartRetrievers Search Tools UI Fonts Hotkeys NotesPanel TabManager ThumbnailsPanel VerificationOptions Events historyChanged Triggered when the annotation history stack changes. This could be used to check the canUndo or canRedo functions if their value has changed. addReply Triggered when a reply has been added to an annotation Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added parent Core.Annotations.Annotation The annotation that is the direct parent of the first annotation root Core.Annotations.Annotation The annotation that is the root parent of the first annotation (may be the same as parent) annotationChanged Triggered when an annotation or annotations have been changed (added, deleted, modified). Attach like annotManager.addEventListener('annotationChanged', callback) Parameters: Name Type Description annotations Array.&lt;Core.Annotations.Annotation&gt; The annotations that were changed action string The action that occurred (add, delete, modify) info Core.AnnotationManager.AnnotationChangedInfoObject An object containing extra information about the annotationChanged event annotationDeselected Triggered after annotations have been deselected. Parameters: Name Type Description annotationList Array.&lt;Core.Annotations.Annotation&gt; List of annotations that have been deselected. annotationDoubleClicked Triggered after an annotation has been double clicked Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that has been double clicked annotationHidden Triggered after annotations have been hidden/shown. Parameters: Name Type Description annotationList Array.&lt;Core.Annotations.Annotation&gt; List of annotations that were hidden or shown hidden boolean Whether the annotations have been hidden or shown annotationsDrawn Triggered after annotations have been drawn for a page Parameters: Name Type Description pageNumber object The page number of all the annotations that were just drawn annotationSelected Triggered after annotation selection has been changed. Parameters: Name Type Description annotationList Array.&lt;Core.Annotations.Annotation&gt; List of annotations that have selected or deselected. action string Either 'selected' or 'deselected' deleteReply Triggered when a reply has been deleted from an annotation Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was deleted root Core.Annotations.Annotation The annotation that is the root parent of the first annotation fieldChanged Triggered when a field's value has been changed. Attach like annotManager.addEventListener('fieldChanged', callback) Parameters: Name Type Description field object The field that was changed value string The field's new value fileAttachmentDataAvailable Triggered after the file attachment data is available after double clicking on the annotation Parameters: Name Type Description fileInfo object Information of the file attachment Properties Name Type Description fileData Blob The blob data of the file attachment filename string The name of the file attachment mimeType string The mimetype attribute of the file attachment setNoteText Triggered when the text should be set on a note Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that needs to have its note text updated root Core.Annotations.Annotation The annotation that is the root parent of the first annotation updateAnnotationPermission 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. Parameters: Name Type Argument Description annotation Core.Annotations.Annotation &lt;optional&gt; The annotation that needs to have its permissions updated calculate A signal that the field should fire its own calculation events. Parameters: Name Type Description source Core.Annotations.Forms.Field The field that caused the calculation event. Listeners of This Event: Core.Annotations.Forms.Field change An event that represents a field's value having changed. Parameters: Name Type Description field Core.Annotations.Forms.Field The field that has changed. commit The field's value has been changed by the user. Sets a new value. Parameters: Name Type Argument Description value string | number &lt;nullable&gt; The new field value. Listeners of This Event: Core.Annotations.Forms.Field editBoxesAvailable Triggered any time edit boxes are drawn on the page. Parameters: Name Type Description boxes object An array of Content Edit boxes. textContentUpdated Triggered when text content of the page is updated. Parameters: Name Type Description originalText string The original text of the selected bounding box. updatedText string The updated text of the selected bounding box. boundingBoxCoordinates object The coordinates (top, left, bottom, right) of the bounding box. colorSeparationAdded Triggered when a color separation is loaded and available on the document. Parameters: Name Type Description colorData object An object with properties of the color separation Properties Name Type Description name string The name of the color separation rgb Array.&lt;any&gt; An array containing the R, G and B values for the separation layersUpdated Triggered when a document's layers/OCG structures change visibility. Parameters: Name Type Description layerContext Array.&lt;Core.Document.LayerContext&gt; array of page layers activeSearchResultChanged Triggered when the active search result has changed Parameters: Name Type Description result object The new active search result, Core.DocumentViewer.SearchResult. annotationsLoaded Triggered when all the annotations embedded in the document have been loaded beforeDocumentLoaded Triggered just before the document has been loaded into the viewer beginRendering Triggered when DocumentViewer starts rendering pages click Triggered for the click event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event dblClick Triggered for the dblClick event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event displayModeUpdated Triggered when the display mode is updated displayPageLocation Triggered when a page location should be displayed Parameters: Name Type Description pageNum number The 1-indexed page number verticalOffset number The offset from the top of the page horizontalOffset number The offset from the left of the page documentLoaded Triggered when a new document has been loaded documentUnloaded Triggered when the current document has been closed and unloaded embeddedThumbnailComplete Triggered when an embedded thumbnail of a viewer-optimized pdf is completely loaded. Parameters: Name Type Description pageNum number The 1-indexed page number finishedRendering Triggered when DocumentViewer finishes rendering pages fitModeUpdated Triggered when the fit mode has changed Parameters: Name Type Description fitMode object The fit mode that has been changed to e.g. docViewer.FitMode.FitWidth keyDown Triggered for the keyDown event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event keyUp Triggered for the keyUp event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseEnter Triggered for the mouseEnter event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseLeave Triggered for the mouseLeave event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseLeftDown Triggered for the mouseLeftButtonDown event in the DocumentViewer's viewing area Attach like docViewer.addEventListener('mouseLeftDown', callback) Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseLeftUp Triggered for the mouseLeftButtonUp event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseMove Triggered for the mouseMove event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseRightDown Triggered for the mouseRightButtonDown event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseRightUp Triggered for the mouseRightButtonUp event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event notify Triggered when there is a notification relating to searching or annotation permissions. Parameters: Name Type Description type string The type of notification that has occurred pageComplete Triggered when a page has been completely rendered. Parameters: Name Type Description pageNum number The 1-indexed page number canvas HTMLCanvasElement The canvas for the page pageNumberUpdated Triggered when the page number is updated Parameters: Name Type Description pageNumber number The new page number (1-indexed) pagesUpdated Triggered when the layout has changed because pages have permanently been added, removed, moved or changed in some other way. Parameters: Name Type Description changes object An object with keys added, removed, moved and contentChanged, indicating which pages have changed rotationUpdated Triggered when the page rotation has changed Parameters: Name Type Argument Description rotation Core.PageRotation The new viewing rotation. pageNumber number &lt;optional&gt; Optionally the specific page number that had its rotation changed searchInProgress Triggered when a search starts or ends. When Core.DocumentViewer#clearSearchResults is executed searchInProgress event is triggered with both inProgress and isFullSearch arguments to be undefined. This can be used to differentiate the search that hasn’t been started versus the search that was done. Parameters: Name Type Description inProgress boolean Whether a search is in progress or not isFullSearch boolean Whether this is a full text search or not searchResultsChanged Triggered when the search results list has changed Parameters: Name Type Description results Array.&lt;object&gt; The new search results, Core.DocumentViewer.SearchResult. tap Triggered when there is a tap in the DocumentViewer's viewing area. Taps are defined as a mouse down and up within a short time period and within a short distance.a Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event textSelected Triggered when the selected text has changed Parameters: Name Type Description quads Array.&lt;Core.Math.Quad&gt; An array of bounding box quads of the selected text text string The selected text pageNumber number The page number that the text was selected on toolModeUpdated Triggered when the tool mode has changed Parameters: Name Type Description newToolObject object The tool object that has been changed to. oldToolObject object The tool object that has been changed from. toolUpdated Triggered when the tool styles or tool name have changed Parameters: Name Type Description toolModeClass object The tool object that has been changed. zoomUpdated Triggered when the zoom level has been updated Parameters: Name Type Description zoom number The new zoom level of the viewer editorBlur Triggered after an editor blurred Parameters: Name Type Description editor Core.Annotations.FreeTextAnnotation.RichTextEditor an instance of Editor annotation Core.Annotations.FreeTextAnnotation a freetext annotation editorFocus Triggered after an editor is focused Parameters: Name Type Description editor Core.Annotations.FreeTextAnnotation.RichTextEditor an instance of Editor annotation Core.Annotations.FreeTextAnnotation a freetext annotation editorSelectionChanged Triggered after selection in the editor changed Parameters: Name Type Description range Core.EditBoxManager.Range current selected range oldRange Core.EditBoxManager.Range previous selected range editorTextChanged Triggered after some text in the editor changed scaleUpdated Triggered when the scale has been updated. Parameters: Name Type Description result object All the scales with related annotations annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolylineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolylineCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.ArcCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.ArcCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PerimeterMeasurementCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PerimeterMeasurementCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.LineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.LineCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolylineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolylineCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangleCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangleCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangularAreaMeasurementTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangularAreaMeasurementTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangleCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangleCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.StickyCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.StickyCreateTool#event:annotationCreated cropApplied Fired when a crop is performed on the document Parameters: Name Type Description cropInfo Object Properties Name Type Description pageNumber number The page number the crop was applied on left number The number of points (pts) cut off the left edge right number The number of points (pts) cut off the right edge bottom number The number of points (pts) cut off the bottom edge top number The number of points (pts) cut off the top edge annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.FreeTextCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.FreeTextCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.LineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.LineCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.EllipseCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.EllipseCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated erasingAnnotation Triggered when an annotation is about to be deleted from the document by the tool Parameters: Name Type Description args object Event arguments with event related properties Properties Name Type Description annotation The annotation that will be deleted skipAnnotation Core.Annotations.FreeHandAnnotation A function you can call to skip deleting the annotation or points from a Example const eraserTool = docViewer.getTool('AnnotationEraserTool'); eraserTool.addEventListener('erasingAnnotation', function(args) { // Make eraser tool skip deleting rectangle annotations if (args.annotation instanceof Annotations.RectangleAnnotation) { args.skipAnnotation(); } }); annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.FreeHandCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.FreeHandCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangleCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangleCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolylineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolylineCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolygonCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolygonCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolylineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolylineCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.EllipseCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.EllipseCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.AreaMeasurementCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.AreaMeasurementCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.StampAnnotation The annotation that was added annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added fileRejected Triggered when a file has been rejected because of exceeding file size limit Parameters: Name Type Description reasons Object The rejection reasons object Properties Name Type Description reason string Reason why the file was rejected maxSize number Maximum accpted file size in bytes size number Uploaded file size in bytes locationSelected Triggered when a page location has been clicked on by the tool Parameters: Name Type Argument Description pageCoordinates Core.Tools.PageCoordinate Indicates where the tool clicked signatureWidget Core.Annotations.SignatureWidgetAnnotation &lt;optional&gt; The signature widget that was clicked to trigger the event signatureDeleted Triggered when the tool deletes a signature Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was deleted index number The index of the annotation in the list signatureSaved Triggered when the tool saves a signature Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was saved annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added fileRejected Triggered when a file has been rejected because of exceeding file size limit Parameters: Name Type Description reasons Object The rejection reasons object Properties Name Type Description reason string Reason why the file was rejected maxSize number Maximum accpted file size in bytes size number Uploaded file size in bytes fileRejected Triggered when a file has been rejected because of exceeding file size limit Parameters: Name Type Description reasons Object The rejection reasons object Properties Name Type Description reason string Reason why the file was rejected maxSize number Maximum accpted file size in bytes size number Uploaded file size in bytes annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangleCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangleCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated selectionComplete Triggered when the user has released the mouse after selecting text Parameters: Name Type Description startLocation object An object with keys \"quad\" and \"pageNumber\" which is the starting quad and page number of the text selection allQuads object An object with keys being the page numbers and values being an array of quads for the selected text on that page annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated mentionChanged Triggered when a mention or mentions have been changed (added, deleted, modified). Attach like instance.mentions.on('mentionChanged', callback) Parameters: Name Type Description mentions UI.MentionsManager.Mention The mentions that were changed action 'add' | 'modify' | 'delete' The action that occurred (add, delete, modify) annotationFilterChanged Triggered when annotation filter in the notes panel has changed. Returns empty arrays if the filter is cleared. Type: object Properties: Name Type Description types Array.&lt;string&gt; Types filter authors Array.&lt;string&gt; Author filter colors Array.&lt;string&gt; Color filter statuses Array.&lt;string&gt; Status filter beforeTabChanged Triggered before the UI switches tabs Type: object Properties: Name Type Description currentTab object An object containing the properties for the currently active tab (null if no currently active tab) Properties Name Type Description id number The id of the tab being switched to src string Source of current tab options string Tab load options annotationsChanged boolean True if the annotations have been changed since loading the tab nextTab object An object containing the properties for the tab being switched to Properties Name Type Description id number The id of the tab being switched to src string Source of current tab options string Tab load options documentLoaded Triggered when a new document has been loaded. documentMerged Triggered when a new document has been merged into the thumbnails panel. Type: object Properties: Name Type Description filename string File name pages Array.&lt;number&gt; Page numbers dragOutline Triggered when dragging Outline item. dragOutline Triggered when dropping Outline item. fileDownloaded Triggered when the file has finished downloading. finishedSavingPDF Deprecated: Since version 8.3. Use fileDownloaded instead fullscreenModeToggled Triggered when fullscreen mode is toggled. Type: object Properties: Name Type Description isInFullscreen boolean Whether in fullscreen mode or not. loaderror Triggered when there is an error loading the document. Parameters: Name Type Description err object The error outlineBookmarksChanged Triggered when outline bookmarks have changed. Parameters: Name Type Description bookmarkData object Properties Name Type Description bookmark object The changed bookmark Properties Name Type Description id string Changed outline bookmark id name string Changed outline bookmark name path string Changed outline path in the outline tree action string The action that triggered the outline bookmarks change panelResized Triggered when the panels are resized. Type: object Properties: Name Type Description element string DataElement name width number New panel width selectedThumbnailChanged Triggered when the selected thumbnail changed. Parameters: Name Type Description selectedThumbnailPageIndexes array The array of indexes of currently selected thumbnails tabAdded Triggered when a Tab is added Type: object Properties: Name Type Description id number The id of the tab being added src string Source of current tab options string Tab load options tabDeleted Triggered when a Tab is deleted Type: object Properties: Name Type Description id number The id of the tab being deleted src string Source of current tab options string Tab load options tabMoved Triggered when a Tab is moved Type: object Properties: Name Type Description id number The id of the tab being moved src string Source of moved tab options string Tab load options prevIndex number Previous index of tab newIndex number New index of tab themeChanged Triggered when the UI theme has changed. Parameters: Name Type Description theme string The new UI theme thumbnailDragged Triggered when thumbnail(s) are dragged in the thumbnail panel thumbnailDropped Triggered when dragged thumbnail(s) are dropped to a new location in the thumbnail panel Type: object Properties: Name Type Description pageNumbersBeforeMove Array.&lt;number&gt; The array of page numbers to be moved pageNumbersAfterMove Array.&lt;number&gt; The array of page numbers of where thumbnails being dropped numberOfPagesMoved number Number of page(s) being moved toolbarGroupChanged Triggered when the toolbar group has changed. Parameters: Name Type Description toolbarGroup string The new toolbar group userBookmarksChanged Triggered when user bookmarks have changed. Parameters: Name Type Description bookmarks object The new bookmarks viewerLoaded Triggered when the viewer has loaded. visibilityChanged Triggered when the visibility of an element has changed. Type: object Properties: Name Type Description element string DataElement name isVisible boolean The new visibility × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:40-07:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer WebViewer WebViewer is a pure JavaScript library to annotate, view, and edit documents inside all major browsers. Instantiation You must instantiate WebViewer in order to access classes and APIs. WebViewer({ licenseKey: 'YOUR_LICENSE_KEY' }, document.getElementById('viewer')) .then(function(instance) { var docViewer = instance.docViewer; var annotManager = instance.annotManager; // call methods from instance, docViewer and annotManager as needed // you can also access major namespaces from the instances as follows: // var Tools = instance.Core.Tools; // var Annotations = instance.Annotations; }); See WebViewer for details. Frequently used namespaces/classes WebViewer - Main instantiation function used to create a WebViewerInstance. WebViewerInstance - An instance of WebViewer. Contains most APIs and Namespaces. Core - The Core namespace on WebViewer instance. Contains APIs related to non-UI parts of WebViewer. UI - The UI namespace on WebViewer instance. Contains APIs related to UI parts of WebViewer. DocumentViewer - A control class used for document viewing and operations. AnnotationManager - A control class used for annotation managing. Document - A class representing a document. Annotations - A namespace containing annotation classes. Tools - A namespace containing tool classes. PDFNet - A namespace containing PDFNet classes (used in fullAPI option). × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:40-07:00 using the DocStrap template. "},"Core.html":{"id":"Core.html","title":"Namespace: Core","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: Core Core WebViewer Instance Core namespace. The namespace containing WebViewer's core user controls, including DocumentViewer control and the Document class. Example webViewerInstance.Core.someProperty webViewerInstance.Core.someAPI() Classes AnnotationHistoryManager AnnotationManager Bookmark DisplayMode DisplayModeManager Document DocumentViewer EditBoxManager EventHandler MeasurementManager Scale Namespaces Actions Annotations ContentEdit Math PartRetrievers Search Tools Members &lt;static&gt; annotationManager AnnotationManager instance Type: Core.AnnotationManager See: Core.AnnotationManager Example WebViewer(...) .then(function(instance) { const annotationManager = instance.Core.annotationManager; }); &lt;static&gt; BackendTypes The types of backend workers. Properties: Name Type Description ASM string 'asm' Use of ASM.js worker. WASM string 'ems' Use of the WebAssembly worker (or ASM.js on non-wasm browsers). THREADED_WASM string 'wasm-threads' Use of threaded WebAssembly worker. &lt;static&gt; ColorPostProcessMode Represents the different color post processing options that can used in the updateRasterizerOptions function. Properties: Name Type Description NONE number No post processing. This is the default setting INVERT number Inverted color mode GRADIENT_MAP number Gradient color mode NIGHT_MODE number Night mode &lt;static&gt; DisplayModes Display modes that control how the document's page are displayed Properties: Name Type Description Single string Displays one page at a time. Continuous string Displays all the pages in a scrolling view in one column. Facing string Displays up to two pages at a time, side by side. FacingContinuous string Displays all pages in a scrolling view in two columns. Cover string Displays all pages in a scrolling view in two columns. The first row has a single page in the second column. CoverFacing string Same as the Cover display mode except that it is not a scrolling view. Custom string Any custom display mode. &lt;static&gt; documentViewer DocumentViewer instance Type: Core.DocumentViewer See: Core.DocumentViewer Example WebViewer(...) .then(function(instance) { const documentViewer = instance.Core.documentViewer; }); &lt;static&gt; FONT_STYLES Represents the font style for the watermark text Properties: Name Type Description BOLD string specifies that the text should be bolded ITALIC string specifies that the text should be italicized UNDERLINE string specifies that the text should be underlined &lt;static&gt; MarkedStates Represents the different Marked state values that you can apply to annotation status. Type: string Properties: Name Type Description Marked string Marked State Unmarked string Unmarked State &lt;static&gt; PageRotation Represents the different page rotation values that you can apply to pages. Type: number Properties: Name Type Description E_0 number 0 degree rotation E_90 number 90 degree rotation E_180 number 180 degree rotation E_270 number 270 degree rotation &lt;static&gt; ReviewStates Represents the different review state values that you can apply to annotation status. Type: string Properties: Name Type Description Accepted string Accepted State Rejected string Rejected State Cancelled string Cancelled State Completed string Completed State None string None State &lt;static&gt; SaveOptions Represents the different save option values that you can use in the getFileData function. Properties: Name Type Description INCREMENTAL number Saves new data to the end of the file REMOVE_UNUSED number Removes unused data when saving HEX_STRINGS number Save strings in hexadecimal format OMIT_XREF number Do not save cross reference table LINEARIZED number Optimize data for speed and remove unused data COMPATIBILITY number Maximize compatibility with older PDF consumers (e.g. the file will not use object and compressed XREF streams) &lt;static&gt; setBasePath Setting the base path that relatively loading documents will be relative to. &lt;static&gt; StateModel Represents the different state models that you can apply to annotation. Type: string Properties: Name Type Description Marked string Marked State Review string Review State &lt;static&gt; SupportedFileFormats Represents all the supported file formats in WebViewer Properties: Name Type Description CLIENT Array.&lt;string&gt; Supported file formats when using WebViewer client side rendering SERVER Array.&lt;string&gt; Supported file formats when using WebViewer with WebViewer Server &lt;static&gt; TextExtractorProcessingFlags Represents the different processing option values to direct the flow of content recognition algorithms that you can use in the setTextExtractorProcessingFlags function. Properties: Name Type Description NO_LIGATURE_EXP number Disables expanding of ligatures using a predefined mapping. Default ligatures are: fi, ff, fl, ffi, ffl, ch, cl, ct, ll, ss, fs, st, oe, OE NO_DUP_REMOVE number Disables removing duplicated text that is frequently used to achieve visual effects of drop shadow and fake bold PUNCT_BREAK number Treat punctuation (e.g. full stop, comma, semicolon, etc.) as word break characters REMOVE_HIDDEN_TEXT number Enables removal of text that is obscured by images or rectangles NO_INVISIBLE_TEXT number Enables removing text that uses rendering mode 3 (i.e. invisible text), which is usually used in 'PDF Searchable Images' (i.e. scanned pages with a corresponding OCR text) NO_WATERMARKS number Enables removal of text that is marked as part of a Watermark layer EXTRACT_USING_ZORDER number Use Z-order as reading order for text Methods &lt;static&gt; BaseDocument() BaseDocument is used to alert if a Document implementation is not following the Document interface. &lt;static&gt; createDatePicker(options) Create DatePicker UI Parameters: Name Type Description options Object An object to set the configuration of the date picker Properties Name Type Description field HTMLElement The HTML form field the date picker should be bound to container HTMLElement DOM node to render calendar into onDateSelected Core.onDateSelected Function that is called when the date is selected from the date picker UI format string the date format showed after select date &lt;static&gt; createDocument(src [, options]) Creates an initialized Core.Document instance. Parameters: Name Type Argument Description src string | File | ArrayBuffer | Blob | Core.PDFNet.PDFDoc Source parameter, path/url to document or File. options Core.CreateDocumentOptions &lt;optional&gt; Create document options. Returns: Promise that resolves when doc.loadAsync has been successfully called and returns Core.Document instance. Type Promise.&lt;Core.Document&gt; &lt;static&gt; disableEmbeddedJavaScript() Disables the execution of embedded JavaScript &lt;static&gt; disableFullPDF() Disable the use of the full version of the PDFNetJS if it had been previously enabled. &lt;static&gt; disableLogs(disabled) Enables or disables all logs coming from WebViewer. Parameters: Name Type Description disabled boolean Whether or not to disable all WebViewer logs. Defaults to true &lt;static&gt; disableOptimizedWorkers() Set flag to indicate that the optimized workers can not be used. See: Core.enableOptimizedWorkers for more details. &lt;static&gt; enableFullPDF() Enable or disable use of the full version of PDFNetJS. the parameter is deprecated since version 8.0 &lt;static&gt; enableOptimizedWorkers() Set flag to indicate that the optimized workers can be used. These workers require some wasm features, e.g. Fixed-Width SIMD, Exception Handling, Bulk Memory Operations. If the browser doesn't support these features, this will have no effect. &lt;static&gt; enableWorkerLogs(enabled) Enables or disables logs from the PDF worker. Parameters: Name Type Description enabled boolean Whether or not to enable PDF worker logs. Defaults to false. &lt;static&gt; forceBackendType(backendType) Set default backend type. This method can be used for forced backend type for specific workers, for example, \"ems\" for Emscripten worker type Parameters: Name Type Description backendType string Value for default backend type, e.g. asm, ems, wasm-threads, jsworker. &lt;static&gt; getAllowedFileExtensions() Get the array of allowed file extensions. An empty array indicates all supported file extensions are allowed. &lt;static&gt; getBuild() Returns the specific hashed commit id that is used to build the current WebViewer version. Returns: A hashed commit id Type string &lt;static&gt; getCanvasMultiplier() Gets the default multiplier used for rendering pages with document.loadCanvas. Higher multipliers mean that pages will be rendered at higher resolutions. The default value is the browser's devicePixelRatio Returns: The current value of the canvas multiplier Type number &lt;static&gt; getCurrentPDFBackendType() Gets the current backend type being used. Returns: Returns \"asm\" if ASM.js is being forced, \"ems\" if Emscripten is being used, \"wasm-threads\" if threaded Wasm is being used and undefined if nothing is being used yet Type string &lt;static&gt; getCurrentPDFBackendType() Gets the current backend type loaded or being loaded Returns: Returns \"asm\" if ASM.js is being forced, \"ems\" if Emscripten is being used or \"wasm-threads\" if threaded Wasm is being used Type Promise.&lt;string&gt; &lt;static&gt; getDefaultBackendType() Gets the default pdf backend type that should be used for this browser. Returns: Returns a promise that resolve to a string. \"ems\" if Emscripten should be used, and \"wasm-threads\" if threaded Wasm should be used Type Promise.&lt;string&gt; &lt;static&gt; getExternalPath() Get the location of external scripts. Returns: the prefix url external scripts. Type string &lt;static&gt; getHashParam(property, defaultValue) Gets the value of the specified hash parameter from the window URL Parameters: Name Type Description property string The property key from hash parameter defaultValue T Default return value Deprecated: Since version 8.3. Please use getHashParameter instead Returns: A value of the hash parameter Type T &lt;static&gt; getHashParameter(property, defaultValue) Gets the value of the specified hash parameter from the window URL Parameters: Name Type Description property string The property key from hash parameter defaultValue T Default return value Returns: A value of the hash parameter Type T &lt;static&gt; getLocalWorkerPath() Get the location of the local worker files. Returns: the path to CORSWorker.js/CoreWorker.js Type string &lt;static&gt; getPDFAsmPath() Get the location of the PDF asm.js file PDFNetC.gz.js. Returns: the prefix url for PDFNetC.gz.js. Type string &lt;static&gt; getPDFResourcePath() Get the location of PDF resources. Returns: the prefix url for PDFNetC.js.mem and PDFNet.res. Type string &lt;static&gt; getPDFWorkerPath() Get the location of the PDF worker. Returns: the prefix url for PDFworker.js Type string &lt;static&gt; getResourcesPath() Gets the path to the resources folder Returns: The path to the resources folder Type string &lt;static&gt; getScrollLeft(ele) Gets the scrollLeft value for the element. Takes into account right to left scrolling direction if applicable. Parameters: Name Type Description ele Element An HTML element to retrieve the scrollLeft value from Returns: The scrollLeft value of the element Type number &lt;static&gt; getVersion() Returns the WebViewer version. Returns: WebViewer version Type string &lt;static&gt; getWorkerPath() Gets the path to the Web Worker JavaScript file Returns: The path to the worker Type string &lt;static&gt; hexStringToNumberArray(hexString) Converts hexadecimal string to a number array. Parameters: Name Type Description hexString string String of hexadecimal characters &lt;static&gt; initPDFWorkerTransports(pdfBackendType, workerHandlers, l) Begins setup of PDF Worker Object. Parameters: Name Type Description pdfBackendType string object representing an PDF backend type (\"asm\", \"ems\" or \"wasm-threads\") workerHandlers object object holding event and error handlers for the worker (workerLoadingProgress, emsWorkerError). l string The license key to use for this worker. If undefined PDFNet will be initialized in demo mode. Returns: a promise that will be resolved when worker transport initialization is complete. &lt;static&gt; isBlendModeSupported(type) Check if a composite operation is supported Parameters: Name Type Description type string Composite operation to check Returns: True if if the input composite operation is supported, false otherwise Type boolean &lt;static&gt; isDemoMode() Returns whether demo mode is active or not. Must be called after the document is loaded or after the call to Core.initPDFWorkerTransports if you're calling it directly. Returns: true or false depending on whether the viewer is in demo mode or not Type boolean &lt;static&gt; isFullPDFEnabled() Returns whether the full version of PDFNetJS is enabled or not. Returns: returns true if the full version is enabled and false otherwise. Type boolean &lt;static&gt; preloadPDFWorker(pdfBackendType, workerHandlers) Begins setup of PDF Worker Object. This can be used to load the workers before a license key has been loaded. Parameters: Name Type Description pdfBackendType string object representing a PDF backend type (\"asm\", \"ems\" or \"wasm-threads\") workerHandlers object object holding event and error handlers for the worker (workerLoadingProgress). Returns: The worker object Type object &lt;static&gt; resetWorker() Resets the worker so that the next time initPDFWorkerTransports is called it will set up the worker transports. &lt;static&gt; setAdvancedImageScaling(advanced) Forces a higher level of accuracy in image downsampling at the expense of rendering performance. This function should be called before loading a document to ensure this setting is used. Parameters: Name Type Description advanced boolean if true advanced image scaling will be used. Can alternatively pass a number for the number of downsampling steps to take. Passing true is equivalent to passing 1.4. &lt;static&gt; setAllowedFileExtensions(fileExtensionArray) Set the allowed file extensions. Parameters: Name Type Description fileExtensionArray Array.&lt;string&gt; An array of file extensions, not case sensitive. An empty array will allow any supported file extension to be loaded. &lt;static&gt; setAsWindowsApp() Flag WebViewer as running inside a Windows App so that it automatically uses the WinRTPartRetriever for loading local XOD files &lt;static&gt; SetCachingLevel(level) Set the caching level between 0 and 10, where 0 is no caching and 10 uses a very large cache. The default is 6. Parameters: Name Type Description level number The level to set &lt;static&gt; setCanvasMultiplier(value) Sets the default multiplier used for rendering pages with document.loadCanvas. Higher multipliers mean that pages will be rendered at higher resolutions. The default value is the browser's devicePixelRatio Parameters: Name Type Description value number The value of multiplier to be set &lt;static&gt; setColorManagement( [boolean]) Enables or color management for PDFNetJS backend. Color management is off by default. Enabling color management will better reflect correct color conversions but has a performance penalty. Parameters: Name Type Argument Description boolean &lt;optional&gt; value if true enable color management. Otherwise disable it. &lt;static&gt; setCustomFontURL(url) Set the URL at which PDFNetJS backend will request font resources for the purposes of font substitution. By default they are retrieved from the pdftron website. Parameters: Name Type Description url string The url at which font resources should be requested. &lt;static&gt; setEmscriptenHeapSize(The) Adjusts the up front heap size used by Emscripten. This method must be called before the worker is initialized to change heap allocation behaviour. By default the heap size is set to 50331648 bytes. Note that decreasing the heap size very low or running complex operations may require a resize. Parameters: Name Type Description The number number of bytes to allocate for the Emscripten heap. &lt;static&gt; setExternalPath() Set the location of external scripts. &lt;static&gt; setIsWindowsApp(isWindowsApp) Sets whether WebViewer is running inside a Windows App and should automatically use the WinRTPartRetriever for loading local XOD files Parameters: Name Type Description isWindowsApp boolean Whether WebViewer is running inside a Windows app or not Deprecated: since version 8.0 Please use setAsWindowsApp or unsetAsWindowsApp instead &lt;static&gt; setLocalWorkerPath(workerPath, isExact) Sets the location of the local worker files CORSWorker.js/CoreWorker.js which will be different when setting the main worker path to another domain. Note that this path should be on the same domain as WebViewer is being loaded. Parameters: Name Type Description workerPath string The path to the local worker files isExact boolean By default this function will add a trailing slash if it wasn't added but in rare cases you may not want this behavior and can pass true for isExact &lt;static&gt; setPDFAsmPath(workerPath) Set the location of the PDF worker. This will override the location specified by Core.setWorkerPath for PDF worker files. Parameters: Name Type Description workerPath string the prefix url for PDFNetC.gz.js. &lt;static&gt; setPDFResourcePath(resourcePath) Set the location of PDF resources. This will override the location specified by Core.setWorkerPath for PDF resource files. Parameters: Name Type Description resourcePath string the prefix url for PDFNetC.js.mem and PDFNet.res. &lt;static&gt; setPDFWorkerPath(workerPath) Set the location of the PDF worker. This will override the location specified by Core.setWorkerPath for PDF worker files. Parameters: Name Type Description workerPath string the prefix url for PDFworker.js &lt;static&gt; SetPreRenderLevel(level) Set the pre-render level between 0 and 10, where 0 has pre-rendering and 10 has a lot of pre-rendering. Parameters: Name Type Description level number The level to set &lt;static&gt; setProgressiveTime(milliseconds) Control the time between progressive events when rendering a more complex page. Parameters: Name Type Description milliseconds number the number of milliseconds between progressive events. By default this is disabled for XOD and 3 seconds (3000) otherwise. &lt;static&gt; setResourcesPath(path) Sets the path to the resources folder. Parameters: Name Type Description path string Path to the resources folder relative to the HTML file &lt;static&gt; setWorkerPath(path) Sets the path to the Web Worker JavaScript file. By default the file is expected to be in the same directory as the html file of the viewer and the path should be specified relative to the html file Parameters: Name Type Description path string Path to the Web Worker JS file relative to the html file of the viewer &lt;static&gt; syncNamespaces(namespaces) Syncs the namespaces under the Core namespace attached to the window only. This is required for interoperability between multiple instances of WebViewer since each loaded instance ends up with different class references despite sharing the same name. Parameters: Name Type Description namespaces object The object containing the namespaces that will be used. Properties Name Type Argument Description PDFNet object &lt;optional&gt; The PDFNet namespace. This is probably the most common that needs to be synced. Actions object &lt;optional&gt; The Actions namespace. Annotations object &lt;optional&gt; The Annotations namespace. Math object &lt;optional&gt; The Math namespace. Tools object &lt;optional&gt; The Tools namespace. &lt;static&gt; unsetAsWindowsApp() Unflag WebViewer as running inside a Windows App so that it doesn't automatically use the WinRTPartRetriever for loading local XOD files. This is unset by default. &lt;static&gt; unsetCanvasMultiplier() Unsets the multiplier that was set using the setCanvasMultiplier function. The multiplier will default back to the browser's devicePixelRatio Type Definitions CreateDocumentOptions Create document options. Properties: Name Type Argument Description l string &lt;optional&gt; Same as licenseKey. licenseKey string &lt;optional&gt; The license key for viewing PDF or Office files (PDF/Office only). You only need to use one of 'l' or 'licenseKey'. docId string &lt;optional&gt; An unique identifier for the document, used for offline mode. onLoadingProgress function &lt;optional&gt; A callback function for loading progress, function signature function(percent) {}. onError function &lt;optional&gt; A callback function that will be called when error occurs in the process of creating a document. function signature function(e) {} workerTransportPromise Promise.&lt;any&gt; &lt;optional&gt; The workerTransportPromise that should be used to load the document. password string | function &lt;optional&gt; A password string or a function of the form function(callback) where callback is of the form function(password). This 'password' function will be called when a password is required to load a PDF document and should call the callback with the retrieved password. filename string &lt;optional&gt; A filename that is used for the downloaded file, and for determining the extension when options.extension isn't used. extension string &lt;optional&gt; Used for specifying the extension of the document to be loaded. This is necessary if the URL/path does not contain the file extension or if you're loading a Blob/File. customHeaders object &lt;optional&gt; An object containing custom HTTP headers to use when retrieving the document from the specified url. For example: {'Authorization' : 'Basic dXNlcm5hbWU6cGFzc3dvcmQ='}. useDownloader boolean &lt;optional&gt; A boolean indicating whether Downloader should be used on urls (PDF only). https://www.pdftron.com/documentation/web/guides/usedownloader-option/. withCredentials boolean &lt;optional&gt; Whether to set the withCredentials property on the XMLHttpRequest. pageSizes Array.&lt;object&gt; &lt;optional&gt; An array of objects in the shape of { width: number, height: number }. Used to determine the page sizes when loading an image file. backendType string &lt;optional&gt; A string representing the \"backend type\" for rendering PDF documents. Pass \"asm\" to force the use of the ASM.js worker, \"ems\" to force the use of the WebAssembly worker (or ASM.js on non-wasm browsers) or \"wasm-threads\" to use threaded WebAssembly. xodOptions object &lt;optional&gt; An object that contains the options for a XOD document. Properties Name Type Argument Description decrypt boolean &lt;optional&gt; Function to be called to decrypt a part of the XOD file. For default XOD AES encryption pass Core.Encryption.decrypt. decryptOptions boolean &lt;optional&gt; An object with options for the decryption e.g. {p: \"pass\", type: \"aes\"} where is p is the password. streaming boolean &lt;optional&gt; A boolean indicating whether to use http or streaming PartRetriever, it is recommended to keep streaming false for better performance. https://www.pdftron.com/documentation/web/guides/streaming-option. azureWorkaround boolean &lt;optional&gt; Whether or not to workaround the issue of Azure not accepting range requests of a certain type. Enabling the workaround will add an extra HTTP request of overhead but will still allow documents to be loaded from other locations. startOffline boolean &lt;optional&gt; Whether to start loading the document in offline mode or not. This can be set to true if the document had previously been saved to an offline database using WebViewer APIs. You'll need to use this option to load from a completely offline state. webviewerServerURL string &lt;optional&gt; A URL to the WebViewer server drop-in backend https://www.pdftron.com/documentation/web/guides/wv-server-deployment. fallbackToClientSide boolean &lt;optional&gt; A boolean indicating whether to fall back to client side rendering when WebViewer server fails cacheKey string &lt;optional&gt; A key that will be used for caching the document on WebViewer Server. forceClientSideInit boolean &lt;optional&gt; If set to true then when loading a document using WebViewer Server the document will always switch to client only rendering allowing page manipulation and the full API to be used. loadAsPDF boolean &lt;optional&gt; If set to true then this will convert any office file passed in into a PDF document customHandlerId number &lt;optional&gt; A field used to specify PDFTron custom security handler. Its value needs to be an integer in [0, 0xFFFFFFFF]. type string &lt;optional&gt; A custom document type. If set then the document type is not determined from the file extension. customDocParams object &lt;optional&gt; An object used to pass properties down to a custom document type. isRelativePath boolean &lt;optional&gt; If true, source will be considered as relative path/url. officeOptions object &lt;optional&gt; An object that contains the options for an Office document. Properties Name Type Argument Description templateValues Core.TemplateData &lt;optional&gt; If set, will perform template replacement with the data specified by this parameter doTemplatePrep boolean &lt;optional&gt; If set, it will interpret the office document as a template document and compile all of the template tags in the document disableBrowserFontSubstitution boolean &lt;optional&gt; By default, office viewing takes a lightweight approach to font substitution, allowing the browser to select fonts when they are not embedded in the document itself. While this means that WebViewer has access to all the fonts on the user's system, it also means that an office document may have a different \"look\" on different systems (depending on the fonts available) and when it is converted to PDF (as the PDF conversion routine cannot obtain low-level access to user fonts, for security reasons). disableBrowserFontSubstitution prevents this browser substitution, forcing the WebViewer backend to handle all fonts. This means that viewing and conversion to PDF will be 100% consistent from system-to-system, at the expense of a slightly slower initial viewing time and higher bandwidth usage. Using https://www.pdftron.com/documentation/web/faq/self-serve-substitute-fonts/ along with this option allows you to fully customize the substitution behaviour for all office files. formatOptions object &lt;optional&gt; An object that contains formatting options for an Office document. Same options as allowed here Core.PDFNet.Convert.OfficeToPDFOptions. Properties Name Type Argument Description applyPageBreaksToSheet boolean &lt;optional&gt; If true will split Excel worksheets into pages so that the output resembles print output. displayChangeTracking boolean &lt;optional&gt; If true will display office change tracking markup present in the document (i.e, red strikethrough of deleted content and underlining of new content). Otherwise displays the resolved document content, with no markup. Defaults to true. excelDefaultCellBorderWidth number &lt;optional&gt; Cell border width for table cells that would normally be drawn with no border. In units of points. Can be used to achieve a similar effect to the \"show gridlines\" display option within Microsoft Excel. excelMaxAllowedCellCount number &lt;optional&gt; An exception will be thrown if the number of cells in an Excel document is above the value. Used for early termination of resource intensive documents. Setting this value to 250000 will allow the vast majority of Excel documents to convert without issue, while keeping RAM usage to a reasonable level. By default there is no limit to the number of allowed cells. locale string &lt;optional&gt; Sets the value for Locale in the options object ISO 639-1 code of the current system locale. For example: 'en-US', 'ar-SA', 'de-DE', etc. onDateSelected(date) Callback function for when a date is selected Parameters: Name Type Description date string selected Date TemplateBoundingBox A bounding box of template tag text or template inserted content. Type: object Properties: Name Type Description pageNum number The page index (1-based indexing) this bounding box appears on. box Core.Math.Rect The bounding box, units are points. TemplateBoundingBoxes A dictionary mapping template keys to bounding boxes of either template tags or template inserted content. The template engine tries to infer the scope of the template that are used in loops. Loop keys will be scoped in this dictionary with the '::' separator, like this: Type: object.&lt;string, Array.&lt;Core.TemplateBoundingBox&gt;&gt; See: https://www.pdftron.com/documentation/windows/guides/generate-via-template/advanced/#explicit-loop-scope for more information on loop scoping. Example 'loop_var_1::loop_var_2 ... ::item_var' TemplateData Office template data (input supplied to applyTemplateValues). Type: Core.TemplateDataKeyValues See: https://www.pdftron.com/documentation/core/guides/generate-via-template/data-model/ for a detailed specification of the template format and supported features. TemplateDataContent A replacement value for a simple data tag, @example '{{tag}}' Type: Core.TemplateDataText | Core.TemplateDataImage TemplateDataImage A bitmap image. All parameters are required. The image will be resized to the requested width and height on the page, which may change it's aspect ratio. Properties: Name Type Description image_url string URL to download image from. width number The image width, measure in points. height number The image height, measured in points. TemplateDataKeyValues A dictionary of template keys and their replacement values. Type: object.&lt;string, Core.TemplateDataValue&gt; TemplateDataLoop The argument to a template loop: an array which will be looped over. Type: Array.&lt;Core.TemplateDataKeyValues&gt; TemplateDataText A text replacement value. Type: string | Core.TemplateDataTextExplicit | Core.TemplateDataTextLines TemplateDataTextExplicit Simple text, equivalent to just passing a string. Properties: Name Type Description text string TemplateDataTextLines An array of text which will separated by line breaks. Properties: Name Type Description text_lines Array.&lt;string&gt; TemplateDataValue A replacement value for a tag. Type: Core.TemplateDataContent | Core.TemplateDataLoop | Core.TemplateDataKeyValues | boolean TemplateSchema Office template schema (output returned from getTemplateKeys with format: schema). Type: object Properties: Name Type Description keys Core.TemplateSchemaKeyValues The top-level template keys in the document. See: https://www.pdftron.com/documentation/core/guides/generate-via-template/data-model/ for a detailed specification of the template format and supported features. TemplateSchemaBool This indicates all usages of the key are used in a conditional. The key is not restricted to a boolean and can take data in the form of content such as a string, but that string would not be rendered anywhere in the document. Type: object Properties: Name Type Description typeId 'TemplateSchemaBool' docOrder number An index representing this template key's first occurrence in the natural flow order of the document's keys (left-to-right, top-to-bottom). TemplateSchemaContent This indicates there is a template tag for this key that will be replaced with content, such as text or an image. Type: object Properties: Name Type Description typeId 'TemplateSchemaContent' docOrder number An index representing this template key's first occurrence in the natural flow order of the document's keys (left-to-right, top-to-bottom). TemplateSchemaKeyValues A dictionary of template keys and their expected data types. Type: object.&lt;string, Core.TemplateSchemaValue&gt; TemplateSchemaLoop This indicates the key is a loop. Since a key may be reused in multiple loops, the loopType property is an array. Type: object Properties: Name Type Description typeId 'TemplateSchemaLoop' docOrder number An index representing this template key's first occurrence in the natural flow order of the document's keys (left-to-right, top-to-bottom). itemSchema Core.TemplateSchemaKeyValues The sub-schema for this loop. Template keys that are used within the loop will appear here. Note that if multiple loops with the same key have different inner keys, the item schema will contain the union of all inner key usages. loopType Array.&lt;('tableRow'|'orderedList'|'unorderedList'|'other')&gt; Array of the loop types, ordered by their document ordering. TemplateSchemaObject This indicates the key is used as an object in a tag dot expression. Type: object Properties: Name Type Description typeId 'TemplateSchemaObject' docOrder number An index representing this template key's first occurrence in the natural flow order of the document's keys (left-to-right, top-to-bottom). properties Core.TemplateSchemaKeyValues The sub-schema for all properties of this object. The properties are gathered from the right-hand-side of all usages of this object in dot expressions. Example 'obj' in the tag '{{obj.prop}}' TemplateSchemaValue The expected type of input data for a template tag. The type can be read from the typeId property. Type: Core.TemplateSchemaContent | Core.TemplateSchemaBool | Core.TemplateSchemaLoop | Core.TemplateSchemaObject × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:40-07:00 using the DocStrap template. "},"Core.Actions.html":{"id":"Core.Actions.html","title":"Namespace: Actions","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: Actions Core. Actions The namespace for anything to do with PDF actions and action dispatch. Actions can be defined by providing a JavaScript object that has the desired properties, and a name property defining the action subtype it represents. See documentation for specific action types for allowable properties. Classes Action Dest GoTo GoToR Hide JavaScript Named ResetForm SubmitForm URI Mixins Dispatcher Members &lt;static&gt; OnTriggeredAdditionalOptions Additional options passed to the onTriggered handler. Properties: Name Type Description originalOnTriggered Core.Actions.ActionOnTriggeredHandler The original onTriggered function of this action action Core.Actions.Action The action that is being triggered Methods &lt;static&gt; setCustomOnTriggeredHandler(actionClass, onTriggeredHandler) Sets a custom handler function that will be called when an action of the specified type is triggered. Parameters: Name Type Description actionClass Core.Actions.Action The class (constructor) of the action onTriggeredHandler Core.Actions.CustomActionOnTriggeredHandler A handler function that will be called when the an action of the specified type is triggered Example Actions.setCustomOnTriggeredHandler(Actions.URI, (target, event, documentViewer, options) =&gt; { if (target instanceof Annotations.Link) { // Don't do anything if the action is triggered by a link return; } options.originalOnTriggered(target, event, documentViewer) }); Type Definitions ActionOnTriggeredHandler(target, event, documentViewer) The onTriggered function for actions. Parameters: Name Type Description target Core.Annotations.Forms.Field | Core.DocumentViewer The dispatcher to which this action is attached event object The embedded JS event that is used when executing the action documentViewer Core.DocumentViewer The DocumentViewer to use as context for the action execution CustomActionOnTriggeredHandler(target, event, documentViewer, options) Handler function that gets passed to Core.Actions.setCustomOnTriggeredHandler. The signature is similar to onTriggered except with an additional options parameter. Parameters: Name Type Description target Core.Annotations.Forms.Field | Core.DocumentViewer The object that the action has been triggered on event object The embedded JS event that is used when executing the action documentViewer Core.DocumentViewer The DocumentViewer to use as context for the action execution options Core.Actions.OnTriggeredAdditionalOptions Additional options and parameters Properties Name Type Description action Core.Actions.Action The action object that is being triggered originalOnTriggered Core.Actions.ActionOnTriggeredHandler The original onTriggered function of this action × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:40-07:00 using the DocStrap template. "},"Core.Actions.Action.html":{"id":"Core.Actions.Action.html","title":"Class: Action","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Action Core.Actions. Action A generic action. new Action(options) Parameters: Name Type Argument Description options object &lt;nullable&gt; A map of properties to set on the Action Properties: Name Type Description name string Get the action's name. Methods onTriggered(owner, event, documentViewer) Called when the action is triggered. Parameters: Name Type Description owner Annotations.Forms.Field | Core.DocumentViewer The dispatcher to which this action is attached event object The PDFJS event to use when executing the action documentViewer Core.DocumentViewer The DocumentViewer to use as context for the action execution × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:40-07:00 using the DocStrap template. "},"Core.Actions.Dest.html":{"id":"Core.Actions.Dest.html","title":"Class: Dest","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Dest Core.Actions. Dest A PDF Destination object, representing a location and fitting strategy. new Dest(options) Parameters: Name Type Argument Description options object &lt;nullable&gt; A map of properties to initialize on the Dest object Properties: Name Type Description page number Gets and sets the 1-based page number to go to. fit string Gets the fit style (One of XYZ, FitBH, FitH, FitBV, FitV, FitR, FitB, Fit) top number | undefined Gets the top of the destination rectangle left number | undefined Gets the left hand side of the destination rectangle bottom number | undefined Gets the bottom of the destination rectangle right number | undefined Gets the right hand side of the destination rectangle zoom number | undefined Gets the zoom at which to view the destination name string | undefined Gets the name of the destination × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Actions.Dispatcher.html":{"id":"Core.Actions.Dispatcher.html","title":"Mixin: Dispatcher","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Mixin: Dispatcher Core.Actions. Dispatcher Creates a dispatcher. A mixin that enables many different classes to construct and dispatch PDF Actions. Methods addAction(trigger, action [, replace]) Add a single action to a trigger. Parameters: Name Type Argument Description trigger string The name of the trigger to which to add the action. action Core.Actions.Action | object The action to add, or an object representing the desired properties (including a name) replace boolean &lt;optional&gt; True if existing actions should be replaced addActions(actions) Add the actions to the dispatcher so they run on next trigger, constructing them if necessary Parameters: Name Type Description actions object The actions to add, as an object with triggers for keys and arrays of action-describing objects for values. getActions() Get all the actions associated with this dispatcher. Returns: The associated actions (in the same format as addActions) Type object getDocumentViewer() Get the associated DocumentViewer. Returns: The associated DocumentViewer instance Type Core.DocumentViewer setDocumentViewer(documentViewer) Set the internal DocumentViewer reference, which is required for some actions to execute correctly. Parameters: Name Type Description documentViewer Core.DocumentViewer The DocumentViewer instance × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Actions.GoTo.html":{"id":"Core.Actions.GoTo.html","title":"Class: GoTo","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: GoTo Core.Actions. GoTo A GoTo Action. Navigates to a specific page of the document with various fit options. new GoTo(options) Parameters: Name Type Argument Description options object &lt;nullable&gt; A map of properties to set on the Action. Properties: Name Type Description dest Core.Actions.Dest Gets the destination object. Extends Core.Actions.Action Methods onTriggered(owner, event, documentViewer) Called when the action is triggered. Parameters: Name Type Description owner Annotations.Forms.Field | Core.DocumentViewer The dispatcher to which this action is attached event object The PDFJS event to use when executing the action documentViewer Core.DocumentViewer The DocumentViewer to use as context for the action execution Inherited From: Core.Actions.Action#onTriggered Overrides: Core.Actions.Action#onTriggered × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Actions.GoToR.html":{"id":"Core.Actions.GoToR.html","title":"Class: GoToR","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: GoToR Core.Actions. GoToR A GoToR Action. Navigates to a destination in another document. new GoToR(options) Parameters: Name Type Argument Description options object &lt;nullable&gt; A map of properties to set on the Action. Properties: Name Type Description dest Core.Actions.Dest Gets the destination object. filename string Gets the original filename of the remote document. newWindow boolean Gets whether the document should be opened in a new window or not. Extends Core.Actions.Action Methods onTriggered(owner, event, documentViewer) Called when the action is triggered. Parameters: Name Type Description owner Annotations.Forms.Field | Core.DocumentViewer The dispatcher to which this action is attached event object The PDFJS event to use when executing the action documentViewer Core.DocumentViewer The DocumentViewer to use as context for the action execution Inherited From: Core.Actions.Action#onTriggered Overrides: Core.Actions.Action#onTriggered × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Actions.Hide.html":{"id":"Core.Actions.Hide.html","title":"Class: Hide","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Hide Core.Actions. Hide Show or hide a list of fields. new Hide(options) Creates a hide action. Parameters: Name Type Argument Description options object &lt;nullable&gt; A map of properties to set on the Action Properties: Name Type Description fields Array.&lt;string&gt; The names of the fields on which the action should operate hide boolean If true, hide the fields in fields, otherwise show them Extends Core.Actions.Action Methods onTriggered(owner, event, documentViewer) Called when the action is triggered. Parameters: Name Type Description owner Annotations.Forms.Field | Core.DocumentViewer The dispatcher to which this action is attached event object The PDFJS event to use when executing the action documentViewer Core.DocumentViewer The DocumentViewer to use as context for the action execution Inherited From: Core.Actions.Action#onTriggered × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Actions.JavaScript.html":{"id":"Core.Actions.JavaScript.html","title":"Class: JavaScript","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: JavaScript Core.Actions. JavaScript A JavaScript action. new JavaScript(options) Parameters: Name Type Argument Description options object &lt;nullable&gt; A map of properties to set on the Action Properties: Name Type Description javascript string The JavaScript string to execute when the action is triggered Extends Core.Actions.Action Methods onTriggered(owner, event, documentViewer) Called when the action is triggered. Parameters: Name Type Description owner Annotations.Forms.Field | Core.DocumentViewer The dispatcher to which this action is attached event object The PDFJS event to use when executing the action documentViewer Core.DocumentViewer The DocumentViewer to use as context for the action execution Inherited From: Core.Actions.Action#onTriggered Overrides: Core.Actions.Action#onTriggered × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Actions.Named.html":{"id":"Core.Actions.Named.html","title":"Class: Named","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Named Core.Actions. Named A named action (currently one of NextPage, PrevPage, FirstPage, LastPage) new Named(options) Parameters: Name Type Argument Description options object &lt;nullable&gt; A map of properties to set on the Action Properties: Name Type Description action string The name of the action to perform. Extends Core.Actions.Action Methods onTriggered(owner, event, documentViewer) Called when the action is triggered. Parameters: Name Type Description owner Annotations.Forms.Field | Core.DocumentViewer The dispatcher to which this action is attached event object The PDFJS event to use when executing the action documentViewer Core.DocumentViewer The DocumentViewer to use as context for the action execution Inherited From: Core.Actions.Action#onTriggered Overrides: Core.Actions.Action#onTriggered × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Actions.ResetForm.html":{"id":"Core.Actions.ResetForm.html","title":"Class: ResetForm","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: ResetForm Core.Actions. ResetForm An action that resets form fields to their default values. new ResetForm(options) Parameters: Name Type Argument Description options object &lt;nullable&gt; A map of properties to set on the Action Properties: Name Type Description fields Array.&lt;string&gt; The names of the fields on which the action should operate exclude boolean Whether the action should reset only the fields specified in fields, or all the fields except those. Extends Core.Actions.Action Methods onTriggered(owner, event, documentViewer) Called when the action is triggered. Parameters: Name Type Description owner Annotations.Forms.Field | Core.DocumentViewer The dispatcher to which this action is attached event object The PDFJS event to use when executing the action documentViewer Core.DocumentViewer The DocumentViewer to use as context for the action execution Inherited From: Core.Actions.Action#onTriggered Overrides: Core.Actions.Action#onTriggered × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Actions.SubmitForm.html":{"id":"Core.Actions.SubmitForm.html","title":"Class: SubmitForm","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: SubmitForm Core.Actions. SubmitForm Submit the form, via various possible protocols, and including/excluding different fields. new SubmitForm(options) Creates a submit-form action. Parameters: Name Type Argument Description options object &lt;nullable&gt; A map of properties to set on the Action Properties: Name Type Description url string The URL to submit the form to fields Array.&lt;string&gt; A list of the names of the fields to operate on format string The format in which to submit the fields (one of fdf, html, xfdf) includeEmpty boolean Whether to include empty fields flags Annotations.WidgetFlags A flags object exposing all flags on the action method string The HTTP method to submit with (either POST or GET) exclude boolean Whether to include or exclude the fields named in fields Extends Core.Actions.Action Methods onTriggered(owner, event, documentViewer) Called when the action is triggered. Parameters: Name Type Description owner Annotations.Forms.Field | Core.DocumentViewer The dispatcher to which this action is attached event object The PDFJS event to use when executing the action documentViewer Core.DocumentViewer The DocumentViewer to use as context for the action execution Inherited From: Core.Actions.Action#onTriggered × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Actions.URI.html":{"id":"Core.Actions.URI.html","title":"Class: URI","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: URI Core.Actions. URI An URI Action. new URI(options) Parameters: Name Type Argument Description options object &lt;nullable&gt; A map of properties to set on the Action Properties: Name Type Description uri string The URI to launch when the action is triggered Extends Core.Actions.Action Methods onTriggered(owner, event, documentViewer) Called when the action is triggered. Parameters: Name Type Description owner Annotations.Forms.Field | Core.DocumentViewer The dispatcher to which this action is attached event object The PDFJS event to use when executing the action documentViewer Core.DocumentViewer The DocumentViewer to use as context for the action execution Inherited From: Core.Actions.Action#onTriggered Overrides: Core.Actions.Action#onTriggered × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.AnnotationHistoryManager.html":{"id":"Core.AnnotationHistoryManager.html","title":"Class: AnnotationHistoryManager","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: AnnotationHistoryManager Core. AnnotationHistoryManager The manager of the Annotation history state for undoing and redoing annotation changes new AnnotationHistoryManager() Extends Core.EventHandler Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); canRedo() Returns whether there is a change available to redo Returns: Whether there is a change that can be redone or not Type boolean canUndo() Returns whether there is a change available to undo Returns: Whether there is a change that can be undone or not Type boolean clear() Clears the undo/redo history so that no older changes can be undone. off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); redo() Reapplies the most recent annotation change that was undone Returns: Returns a promise that resolves when the operation is complete Type Promise.&lt;void&gt; removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); undo() Undoes the most recent annotation change Returns: Returns a promise that resolves when the operation is complete Type Promise.&lt;void&gt; Events historyChanged Triggered when the annotation history stack changes. This could be used to check the canUndo or canRedo functions if their value has changed. × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.AnnotationManager.html":{"id":"Core.AnnotationManager.html","title":"Class: AnnotationManager","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: AnnotationManager Core. AnnotationManager Represents an object that manages the Annotations that appear on a Document's pages when displayed in a DocumentViewer. new AnnotationManager(docViewer) Creates a new instance of AnnotationManager. Parameters: Name Type Description docViewer Core.DocumentViewer Properties: Name Type Description controlPointSize number The size of annotation control points. controlPointHitBoxScale number The scale of the hit box of the annotation control points. Increase to increase the selectable area. Extends Core.EventHandler Members &lt;static&gt; AnnotationChangedActions The different action types for the annotationChanged event. Properties: Name Type Description ADD string When the annotationChanged event triggered due to adding annotations DELETE string When the annotationChanged event triggered due to deleting annotations MODIFY string When the annotationChanged event triggered due to modifying annotations &lt;static&gt; Events Properties: Name Type Description ANNOTATION_SELECTED string Core.AnnotationManager.annotationSelected ANNOTATION_DESELECTED string Core.AnnotationManager.annotationDeselected ANNOTATION_DOUBLE_CLICKED string Core.AnnotationManager.annotationDoubleClicked ANNOTATION_CHANGED string Core.AnnotationManager.annotationChanged UPDATE_ANNOTATION_PERMISSION string Core.AnnotationManager.updateAnnotationPermission ANNOTATIONS_DRAWN string Core.AnnotationManager.annotationsDrawn ANNOTATION_HIDDEN string Core.AnnotationManager.annotationHidden SET_NOTE_TEXT string Core.AnnotationManager.setNoteText ADD_REPLY string Core.AnnotationManager.addReply DELETE_REPLY string Core.AnnotationManager.deleteReply FIELD_CHANGED string Core.AnnotationManager.fieldChanged FILE_ATTACHMENT_DATA_AVAILABLE string Core.AnnotationManager.fileAttachmentDataAvailable &lt;static&gt; RotationTypes Represents the types of rotations available to perform on an annotation. Type: string Properties: Name Type Description SNAP_ROTATION string Rotate an annotation in discrete steps, such as 45 or 90 degrees FREEFORM_ROTATION string Rotate an annotation continuously Methods addAnnotation(annotation [, options]) Adds the specified annotation to the managed list of annotations. Parameters: Name Type Argument Description annotation Core.Annotations.Annotation | Array.&lt;Core.Annotations.Annotation&gt; An instance of Annotation. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description imported boolean &lt;optional&gt; false Whether the annotation was imported from another source or not isUndoRedo boolean &lt;optional&gt; false Whether the annotation change was caused by undo/redo or not autoFocus boolean &lt;optional&gt; false Whether the annotation's text input should be automatically focused if applicable. Relevant to FreeText and Callout annotations. addAnnotations(annotations [, options]) Adds the specified annotations to the managed list of annotations. Parameters: Name Type Argument Description annotations Array.&lt;Core.Annotations.Annotation&gt; An array of annotations. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description imported boolean &lt;optional&gt; false Whether the annotations were imported from another source or not isUndoRedo boolean &lt;optional&gt; false Whether the annotation change was caused by undo/redo or not autoFocus boolean &lt;optional&gt; false Whether the annotation's text input should be automatically focused if applicable. Relevant to FreeText and Callout annotations. addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); applyRedactions( [annotations]) Apply redaction annotations Parameters: Name Type Argument Description annotations Core.Annotations.Annotation | Array.&lt;Core.Annotations.Annotation&gt; &lt;optional&gt; 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. Returns: 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. Type Promise.&lt;(Array.&lt;Core.AnnotationManager.RedactionInfo&gt;|string)&gt; bringToBack(annotation) Move the annotation to the beginning of the managed list of annotations, so that it will be shown behind all annotations. Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that will be shown in the back. bringToFront(annotation) Move the annotation to the end of the managed list of annotations, so that it will be shown on top of all annotations. Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that will be shown in the front. canModify(annotation) Whether or not the current user can modify the annotation. Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation to check permissions on. Returns: Whether the annotation can be modified or not. Type boolean canModifyContents(annotation) Whether or not the current user can modify the annotation's contents. Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation to check permissions on. Returns: Whether the annotation's contents can be modified or not. Type boolean createAnnotationReply(annotation, initialText) Creates an annotation that replies to the passed in annotation. Annotation replies are sticky note annotations. Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation to add a reply to initialText string The initialText for the annotation, defaults to the empty string Returns: The created annotation reply Type Core.Annotations.StickyAnnotation deleteAnnotation(annotation [, options]) 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. Parameters: Name Type Argument Description annotation Core.Annotations.Annotation | Array.&lt;Core.Annotations.Annotation&gt; An instance of Annotation. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Description imported boolean &lt;optional&gt; Whether the annotation was imported from another source or not OR a option parameters contains force boolean &lt;optional&gt; If true then the annotation will be deleted regardless of the user's current permissions isUndoRedo boolean &lt;optional&gt; Whether the annotation change was caused by undo/redo or not source string &lt;optional&gt; What type of action cause this event (i.e. \"redactionApplied\") deleteAnnotations(annotation [, options]) 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. Parameters: Name Type Argument Description annotation Array.&lt;Core.Annotations.Annotation&gt; An array of annotations options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Description imported boolean &lt;optional&gt; Whether the annotations were imported from another source or not force boolean &lt;optional&gt; If true then the annotations will be deleted regardless of the user's current permissions isUndoRedo boolean &lt;optional&gt; Whether the annotation change was caused by undo/redo or not source string &lt;optional&gt; What type of action cause this event (i.e. \"redactionApplied\") demoteUserFromAdmin() Demote the current user so they are no longer an admin user. deregisterAnnotationType(elementName, annotationClass) Deregisters an annotation class. Parameters: Name Type Description elementName string the string representing the xml element name of the annotation annotationClass Class.&lt;Core.Annotations.Annotation&gt; the class (constructor) of the annotation Returns: true if deregistration was successful Type Boolean deselectAllAnnotations() 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. deselectAnnotation(annotation) 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\" Parameters: Name Type Description annotation Core.Annotations.Annotation An instance of Annotation. deselectAnnotations(annotations) 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\" Parameters: Name Type Description annotations Array.&lt;Core.Annotations.Annotation&gt; An array of annotation instances disableDraggingAcrossPages() Disable dragging annotations across pages. disableFreeformRotation() Disables freeform rotation for annotations. Deprecated: since version 8.2 Please use setRotationOptions instead disableFreeTextEditing() Disables the editing of free text annotations directly on the annotation. disableReadOnlyMode() Disables read-only mode in the viewer. disableRedaction() Disable redaction tools disableStampVectorAppearance() 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. drawAnnotations(options) Draws all annotations associated with the given page number. Note that the entire annotation canvas for the page will be redrawn. Parameters: Name Type Description options object An object that can contain the following parameters Properties Name Type Argument Description pageNumber number The page number of the page to draw overrideCanvas object &lt;optional&gt; Optionally draw directly to this canvas majorRedraw boolean &lt;optional&gt; Signify that this is a major redraw, so widget-like annotations must be re-rendered as well overrideContainer object &lt;optional&gt; Optionally the container HTML element that the widget annotations should be appended to Returns: Returns a promise that resolves when all the annotations on the page have been drawn Type Promise.&lt;any&gt; drawAnnotationsFromList(annotationList) 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. Parameters: Name Type Description annotationList Array.&lt;Core.Annotations.Annotation&gt; | Core.Annotations.Annotation List of annotations or a single annotation object Returns: Returns a promise that resolves when all the annotations in the annotationList have been drawn Type Promise.&lt;any&gt; enableDraggingAcrossPages() Enable dragging annotations across pages. enableFreeformRotation() Enables freeform rotation for annotations Deprecated: since version 8.2 Please use setRotationOptions instead enableReadOnlyMode() Enables read-only mode in the viewer. In this mode no annotations can be added or commented on. enableRedaction() Enable redaction tools Please use enableRedaction or disableRedaction without passing parameters Using a parameter is deprecated in version 8.0 exportAnnotationCommand() 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. Returns: Returns a promise that resolves to an XFDF command string Type Promise.&lt;string&gt; exportAnnotations( [options]) Exports all annotations as an XFDF (XML) string Parameters: Name Type Argument Description options object &lt;optional&gt; Options for the export. Set options.widgets or options.links or options.fields to false to disable exporting of them. Properties Name Type Argument Description annotList Array.&lt;Core.Annotations.Annotation&gt; &lt;optional&gt; An array of annotations to only export the XFDF for those particular annotations. widgets boolean &lt;optional&gt; Whether to export widget information links boolean &lt;optional&gt; Whether to export links information fields boolean &lt;optional&gt; Whether to export fields information useDisplayAuthor boolean &lt;optional&gt; Whether to export annotations with the Display Author name from annotationManager.getDisplayAuthor() generateInlineAppearances boolean &lt;optional&gt; Whether to generate custom appearance strings for annotations that have an appearance generated on export (e.g. freetext). Default: true Returns: Returns a promise that resolves with the XFDF (XML) annotations as a string Type Promise.&lt;string&gt; exportAnnotCommand() 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. Deprecated: Since version 8.3. Please use exportAnnotationCommand instead Returns: Returns a promise that resolves to an XFDF command string Type Promise.&lt;string&gt; getAnnotationById(id [, annotationList]) Gets an annotation object by the annotation's ID. Parameters: Name Type Argument Description id string The ID of the annotation. annotationList Array &lt;optional&gt; Optionally pass your own array of annotations to search in Returns: An annotation object. Type Core.Annotations.Annotation getAnnotationByMouseEvent(event) 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. Parameters: Name Type Description event MouseEvent A DOM mouse event. Returns: An annotation object. Type Core.Annotations.Annotation getAnnotationCopy(annotation, options) Returns a deep copy of the annotation Parameters: Name Type Description annotation Core.Annotations.Annotation An instance of Annotation to be copied. options Object Options for this function Properties Name Type Description copyAssociatedLink boolean Whether to make a deep copy of an associated link Returns: a copy of the annotation, null if annotation cannot be copied Type Core.Annotations.Annotation getAnnotationFromPopup(popup) Gets the annotation associated with the popup object. Parameters: Name Type Description popup object The popup object associated with an annotation Returns: The annotation that the popup belongs to Type Core.Annotations.Annotation getAnnotationsByMouseEvent(event) 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. Parameters: Name Type Description event MouseEvent A DOM mouse event. Returns: An array of annotation objects. Type Array.&lt;Core.Annotations.Annotation&gt; getAnnotationsList() Gets the list of all annotations managed by the AnnotationManager. Returns: An array of Annotations. Type Array.&lt;Core.Annotations.Annotation&gt; getCopiedAnnotations() Get copied annotations. Returns: returns array of copied annotations Type Array.&lt;Core.Annotations.Annotation&gt; getCurrentUser() Returns the user name of the current user. Returns: The user name of the current user. Type string getDisplayAuthor(annotationUserId) 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. Parameters: Name Type Description annotationUserId string Annotation userId Returns: The display author name Type string getEditBoxManager() Returns: Returns an instance of EditorBoxManager Type Core.EditBoxManager getFieldManager() Gets the associated field manager. Returns: Type Core.Annotations.Forms.FieldManager getGroupAnnotations(annotation) Gets all the annotations that are grouped with the passed in annotation, including said annotation. Parameters: Name Type Description annotation Core.Annotations.Annotation An annotation in the group Returns: Gets all the annotations that are grouped with the passed in annotation, including said annotation. Type Array.&lt;Core.Annotations.Annotation&gt; getIsAdminUser() Returns whether the current user has admin privileges. Deprecated: Since version 8.0. Use isUserAdmin instead. Returns: true if the current user is an admin, false otherwise. Type boolean getNumberOfGroups() Gets the number of annotations in the current selection Returns: The number of groups in the current selection. A loose annotation is a group of 1. Type number getReadOnly() Returns whether the viewer is currently in read-only mode. Deprecated: Since version 8.0. Use isReadOnlyModeEnabled instead. Returns: true if the current viewer is in read-only mode, false otherwise. Type boolean getRegisteredAnnotationTypes() Gets a map of registered annotations. This can be modified directly, instead of using AnnotationManager#registerAnnotationType and AnnotationManager#deregisterAnnotationType. Returns: 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. Type object getRootAnnotation(annotation) Gets the root annotation that this annotation is replying to. If this annotation is not replying to anything then the root is itself. Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation from which to find the root annotation in the reply chain Returns: The root annotation Type Core.Annotations.Annotation getRotationOptions() Gets the rotation options for annotation manager. Returns: An object containing rotation options for annotation manager. Type object Example const { Core } = instance; const annotManager = Core.documentViewer.getAnnotationManager(); const rotationOptions = annotManager.getRotationOptions(); getSelectedAnnotations() Returns the list of selected annotations. Returns: An array of selected annotations. Type Array.&lt;Core.Annotations.Annotation&gt; getSnapDefaultOptions() Get the current snap options for annotation tool snapping Returns: The snap mode options. Type Core.AnnotationManager.snapDefaultOptions groupAnnotations(primaryAnnotation, annotations) Groups an array of annotations Parameters: Name Type Description primaryAnnotation Core.Annotations.Annotation The primary annotation for this group. annotations Array.&lt;Core.Annotations.Annotation&gt; The array of annotations to group. hasAnnotation(annotation) Determines if the specified annotation exists in the managed list of annotations. Parameters: Name Type Description annotation Core.Annotations.Annotation An instance of Annotation. hideAnnotation(annot) Hides the specified annotation. Parameters: Name Type Description annot Core.Annotations.Annotation The annotation to hide hideAnnotations(annots) Hides all of the annotations in the list Parameters: Name Type Description annots Array.&lt;Core.Annotations.Annotation&gt; Array of annotations to hide importAnnotationCommand(xfdfString) Updates the viewer with the xfdf changes (add/modify/delete) in the xml string Parameters: Name Type Description xfdfString string The XML annotation updates as a string Returns: A promise that resolves to the list of annotations that were updated Type Promise.&lt;Array.&lt;Core.Annotations.Annotation&gt;&gt; importAnnotations(xfdfString [, options]) Loads XFDF annotations into the viewer Parameters: Name Type Argument Description xfdfString string The XFDF annotations as a string options object &lt;optional&gt; The options for importing Properties Name Type Argument Description batchSize number &lt;optional&gt; The number of annotations to import in each batch (default 100) batchDelay number &lt;optional&gt; The amount of time in milliseconds to delay between importing each batch (default 0) replace Core.Annotations.Annotation | Array.&lt;Core.Annotations.Annotation&gt; &lt;optional&gt; The type of existing annotations that will be removed before import starts (default []) Returns: Returns a promise that resolves with the annotations have been imported Type Promise.&lt;any&gt; importAnnotCommand(xfdfString) Updates the viewer with the xfdf changes (add/modify/delete) in the xml string Parameters: Name Type Description xfdfString string The XML annotation updates as a string Deprecated: Since version 8.3. Please use importAnnotationCommand instead Returns: A promise that resolves to the list of annotations that were updated Type Promise.&lt;Array.&lt;Core.Annotations.Annotation&gt;&gt; isAnnotationRedactable(annotation) 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 Parameters: Name Type Description annotation Core.Annotations.Annotation An annotation to check if it redactable Returns: True if annotation can be redacted (WebViewer is set up correctly for applying), false otherwise Type boolean isAnnotationSelected(annotation) Returns whether an annotation is currently selected Parameters: Name Type Description annotation Core.Annotations.Annotation An instance of Annotation. Returns: true if annotation is selected, false otherwise Type boolean isApplyRedactionEnabled() Check if applying redaction is enabled Returns: True if applying redactions is enabled, false otherwise Type boolean isCreateRedactionEnabled() Check if creating redaction is enabled Returns: True if creating redactions is enabled, false otherwise Type boolean isDraggingAcrossPagesEnabled() Check if dragging annotations across pages is enabled. Returns: True if dragging annotations across pages is enabled, false otherwise. Type boolean isFreeformRotationEnabled() Returns whether freeform rotation is enabled for annotations. Deprecated: since version 8.2 Please use getRotationOptions instead Returns: true if freeform rotation is enabled, false otherwise. Type boolean isFreeTextEditingEnabled() Returns whether free text editing is enabled directly on the annotation. Returns: true if free text editing is enabled, false otherwise. Type boolean isReadOnlyModeEnabled() Returns whether the viewer is currently in read-only mode. Returns: true if the current viewer is in read-only mode, false otherwise. Type boolean isUserAdmin() Returns whether the current user has admin privileges. Returns: true if the current user is an admin, false otherwise. Type boolean jumpToAnnotation(annotation [, options]) Jumps to the page of the annotation and if it isn't visible then centers it in the window. Parameters: Name Type Argument Description annotation Core.Annotations.Annotation The annotation to be jumped to. options Object &lt;optional&gt; Optional settings for jump behaiour. Default will guarantee the annotation will be on the screen at the current zoom level. Properties Name Type Argument Default Description horizontalOffset string &lt;optional&gt; auto 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. verticalOffset string &lt;optional&gt; auto 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. zoom string &lt;optional&gt; 1 The level of zoom, 1 being 100% zoom. fitToView boolean &lt;optional&gt; false If set to true the zoom will fit the entire annotation within the viewport. isSmoothScroll boolean &lt;optional&gt; false If set to true, the viewer will scroll to the annotation in a smooth way. off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); pasteCopiedAnnotations( [useMouseLocation]) Pastes the currently copied annotations. Parameters: Name Type Argument Default Description useMouseLocation boolean &lt;optional&gt; false Whether or not to paste the annotations based on the position of the mouse cursor in the window, accounting for the scroll position promoteUserToAdmin() Promote the current user to be an admin user. Admin users can edit any annotations. redrawAnnotation(annotation) Redraws the specified annotation. Note that the entire annotation canvas for the page will be redrawn. Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation to be redrawn. registerAnnotationType(elementName, annotationClass) Registers an annotation class. Annotations that are registered will be serialized and deserialized by the AnnotationManager. Parameters: Name Type Description elementName string the string representing the xml element name of the annotation annotationClass Class.&lt;Core.Annotations.Annotation&gt; the class (constructor) of the annotation Returns: true if registration was successful Type Boolean removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); selectAnnotation(annotation) 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\" Parameters: Name Type Description annotation Core.Annotations.Annotation An instance of Annotation. selectAnnotations(annotations) 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\" Parameters: Name Type Description annotations Array.&lt;Core.Annotations.Annotation&gt; An array of Annotations. setAnnotationCanvasTransform(annotCanvasContext, zoom, rotation) Set the page transform of an annotation canvas Parameters: Name Type Description annotCanvasContext CanvasRenderingContext2D Annotation canvas context to draw on zoom number The zoom or the scaling of the page canvas rotation Core.PageRotation The rotation of the page canvas setAnnotationDisplayAuthorMap(mapFunction) Sets the mapping function used to get the display name for annotation authors and is used when calling getDisplayAuthor. Parameters: Name Type Description mapFunction function The mapping function to use. The function is passed a userID/GUID and should return the display name for the UI. Example annotManager.setAnnotationDisplayAuthorMap((annotationUserId) =&gt; { if (annotationUserId === '1') { return 'John'; } else { return 'Guest'; } }); setAnnotationRichTextStyle(annotation, style) Sets the rich text style for the specified annotation Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that will have its rich text style updated. style Core.Annotations.Annotation.RichTextStyle The object to update the rich text style to. setAnnotationStyles(annotation, newStyles) Set the styles for the annotation Parameters: Name Type Description annotation Core.Annotations.Annotation an annotation of which the styles will be changed. newStyles object | function 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. setBeforeSubmitFormActionCallback(callback) 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 Parameters: Name Type Description callback Core.AnnotationManager.setBeforeSubmitFormActionCallbackFunction The function that will be called prior to invocation of the SubmitForm API. setCurrentUser(user) Sets the current user of the viewer. Parameters: Name Type Description user string the user name of the current user. setCustomAppearanceHandler(func) 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. Parameters: Name Type Description func function Function which must return Document object created with Core.createDocument setFreeformRotationEnabled(freeformRotationEnabled) Sets whether the annotations will have freeform rotation enabled. Parameters: Name Type Description freeformRotationEnabled boolean true if freeform rotation should be enabled, false otherwise. Deprecated: since version 8.0 Please use setRotationOptions instead setIsAdminUser(isAdminUser) Sets whether the current user is an admin user. Parameters: Name Type Description isAdminUser boolean true if the current user is an admin, false otherwise. Deprecated: since version 8.0 Please use promoteUserToAdmin or demoteUserFromAdmin instead setNoteContents(annotation, text) Sets the value of the note for the specified annotation. Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that will have its note updated. text string The value to update the note text to. setOldStickyNoteRenderingDate(date) Changes the sticky note rendering to the old implementation when the sticky note has been created before the specified date. Parameters: Name Type Description date number The date timestamp to use setPermissionCheckCallback(callback) Sets the function that should be used to determine if the annotation can be modified or not. Parameters: Name Type Description callback function The function that should be called. Should return true or false. setReadOnly(readOnly) Sets whether the viewer is currently in read-only mode. Parameters: Name Type Description readOnly boolean true if the viewer is in read-only mode, false otherwise. Deprecated: since version 8.0 Please use enableReadOnlyMode or disableReadOnlyMode instead setRedrawThrottle(value) Sets the rate at which the redrawing of annotations is throttled. This can improve annotation rendering on lower quality devices and browsers. Parameters: Name Type Description value number The throttled rate at which annotations will be redrawn, in milliseconds Deprecated: Since version 8.0. Use setRedrawThrottleRate instead. setRedrawThrottleRate(value) Sets the rate at which the redrawing of annotations is throttled. This can improve annotation rendering on lower quality devices and browsers. Parameters: Name Type Description value number The throttled rate at which annotations will be redrawn, in milliseconds setRotationOptions(options) Sets the rotation options for annotation manager. Parameters: Name Type Description options object An object that can contain the following parameters Properties Name Type Argument Description isEnabled boolean &lt;optional&gt; Whether rotations are enabled or not. hotkeyTogglesRotationType boolean &lt;optional&gt; Determines if rotation type performed is toggled when holding down shift key. defaultRotationType string &lt;optional&gt; Determines which rotation type will be performed without holding shift key. snapAngleStepSizeInDegrees number &lt;optional&gt; The angle (in degrees) applied to each snap rotation. Valid range is between 0 and 180. Example // 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 }); setSnapDefaultOptions(options) Set the snap options for annotation tool snapping Parameters: Name Type Description options Core.AnnotationManager.snapDefaultOptions The snap mode options. setSubmitFormActionCallback(callback) Sets the function to be called when a submit form action is triggered. Parameters: Name Type Description callback function The function that should be called. Will be passed the form data. showAnnotation(annot) Shows the annotation Parameters: Name Type Description annot Core.Annotations.Annotation The annotation to show showAnnotations(annots) Shows all of the annotations in the list Parameters: Name Type Description annots Array.&lt;Core.Annotations.Annotation&gt; Array of annotations to show trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); ungroupAnnotations(annotations) Ungroups an array of annotations Parameters: Name Type Description annotations Array.&lt;Core.Annotations.Annotation&gt; The array of annotations to ungroup. updateAnnotation(annotation) Redraws the annotations on the same page as the specified annotation if the annotation has been added. Parameters: Name Type Description annotation Core.Annotations.Annotation An instance of Annotation. updateAnnotationRichTextStyle(annotation, style [, start] [, end]) Update the rich text style for the specified annotation Parameters: Name Type Argument Description annotation Core.Annotations.Annotation The annotation that will have its rich text style updated. style Core.Annotations.Annotation.StyleObject The object to update the rich text style to. Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to start number &lt;optional&gt; Optional starting index to apply the style, if not set, will start at 0 end number &lt;optional&gt; Optional ending index for the style, if not set, will apply style to end of text updateAnnotationState(annotation, state, stateModel, message) Updates the annotation state. This is done by creating an annotation that replies to the passed in annotation. Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation to add a reply to state string 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. stateModel string Gets or sets the stateModel of the annotation. stateModel has two statemodels: Marked, Review. Default is Review. message string Message to be set when the state is updated. Returns: The created annotation reply Type Core.Annotations.StickyAnnotation updateCopiedAnnotations() Copies the currently selected annotations. useFreeTextEditing() Returns whether free text editing is enabled directly on the annotation. Deprecated: Since version 8.0. Use isFreeTextEditingEnabled instead. Returns: true if free text editing is enabled, false otherwise. Type boolean Type Definitions AnnotationChangedInfoObject Type: Object Properties: Name Type Description imported boolean 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 isUndoRedo boolean A boolean that will be true if the annotation change is the result of an undo or redo action source string An optional string that indicates what type of action caused this event (i.e. \"redactionApplied\") RedactionInfo Type: object Properties: Name Type Description pageNumber number The page number of the redaction rect Core.Math.Rect A rect containing the bounding box of the redaction setBeforeSubmitFormActionCallbackFunction(submitFormParams) Parameters: Name Type Description submitFormParams Core.AnnotationManager.SubmitFormParams An object corresponding to the parameters passed when the submitForm API was invoked snapDefaultOptions Type: Object Properties: Name Type Description radiusThreshold number The distance threshold in pixel for snap feature to be effective. indicatorSize number The side length in pixels of the snap indicator's bounding square. indicatorColor string The color of the snap indicator. Accepts CSS HEX or CSS RGBA value. SubmitFormParams Type: Object Properties: Name Type Description fields array An array of field names to submit empty boolean If true, submit all fields, including those that have no value. If false, exclude fields that currently have no value fdf boolean If true, form data is submitted as FDF. If false, it is submitted as XFDF url string The URL to submit the form data to Events addReply Triggered when a reply has been added to an annotation Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added parent Core.Annotations.Annotation The annotation that is the direct parent of the first annotation root Core.Annotations.Annotation The annotation that is the root parent of the first annotation (may be the same as parent) annotationChanged Triggered when an annotation or annotations have been changed (added, deleted, modified). Attach like annotManager.addEventListener('annotationChanged', callback) Parameters: Name Type Description annotations Array.&lt;Core.Annotations.Annotation&gt; The annotations that were changed action string The action that occurred (add, delete, modify) info Core.AnnotationManager.AnnotationChangedInfoObject An object containing extra information about the annotationChanged event annotationDeselected Triggered after annotations have been deselected. Parameters: Name Type Description annotationList Array.&lt;Core.Annotations.Annotation&gt; List of annotations that have been deselected. annotationDoubleClicked Triggered after an annotation has been double clicked Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that has been double clicked annotationHidden Triggered after annotations have been hidden/shown. Parameters: Name Type Description annotationList Array.&lt;Core.Annotations.Annotation&gt; List of annotations that were hidden or shown hidden boolean Whether the annotations have been hidden or shown annotationsDrawn Triggered after annotations have been drawn for a page Parameters: Name Type Description pageNumber object The page number of all the annotations that were just drawn annotationSelected Triggered after annotation selection has been changed. Parameters: Name Type Description annotationList Array.&lt;Core.Annotations.Annotation&gt; List of annotations that have selected or deselected. action string Either 'selected' or 'deselected' deleteReply Triggered when a reply has been deleted from an annotation Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was deleted root Core.Annotations.Annotation The annotation that is the root parent of the first annotation fieldChanged Triggered when a field's value has been changed. Attach like annotManager.addEventListener('fieldChanged', callback) Parameters: Name Type Description field object The field that was changed value string The field's new value fileAttachmentDataAvailable Triggered after the file attachment data is available after double clicking on the annotation Parameters: Name Type Description fileInfo object Information of the file attachment Properties Name Type Description fileData Blob The blob data of the file attachment filename string The name of the file attachment mimeType string The mimetype attribute of the file attachment setNoteText Triggered when the text should be set on a note Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that needs to have its note text updated root Core.Annotations.Annotation The annotation that is the root parent of the first annotation updateAnnotationPermission 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. Parameters: Name Type Argument Description annotation Core.Annotations.Annotation &lt;optional&gt; The annotation that needs to have its permissions updated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Annotations.html":{"id":"Core.Annotations.html","title":"Namespace: Annotations","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: Annotations Core. Annotations The namespace for anything to do with PDF annotations. Classes Annotation ArcAnnotation Border BoxControlHandle BoxSelectionModel ButtonWidgetAnnotation CalloutControlHandle CalloutSelectionModel CanvasHelper CaretAnnotation CheckButtonWidgetAnnotation ChoiceWidgetAnnotation Color ControlHandle CustomAnnotation DatePickerWidgetAnnotation EllipseAnnotation FileAttachmentAnnotation Font Forms FreeHandAnnotation FreeTextAnnotation FreeTextSelectionModel HTMLAnnotation IPathAnnotation LineAnnotation LineControlHandle LineSelectionModel Link ListWidgetAnnotation MarkupAnnotation Model3D PathControlHandle PathSelectionModel PolygonAnnotation PolygonControlHandle PolygonSelectionModel PolylineAnnotation PopupAnnotation RadioButtonWidgetAnnotation RectangleAnnotation RedactionAnnotation RedactionSelectionModel RotationControlHandle RotationUtils SelectionAlgorithm SelectionModel SignatureWidgetAnnotation SoundAnnotation StampAnnotation StickyAnnotation TextHighlightAnnotation TextMarkupAnnotation TextRedactAnnotation TextSelectionModel TextSquigglyAnnotation TextStrikeoutAnnotation TextUnderlineAnnotation TextWidgetAnnotation WidgetAnnotation WidgetFlags XFDFUtils Members &lt;static&gt; LineEndType An enum representing different line end types that are available for line annotations Type: string Properties: Name Type Description NONE string No line endings OPEN_ARROW string an arrow that points outward R_OPEN_ARROW string an arrow that points inward CLOSED_ARROW string a triangle that points outward R_CLOSED_ARROW string a triangle that points inward BUTT string a vertical line SQUARE string a square DIAMOND string a diamond CIRCLE string a circle SLASH string a slash Methods &lt;static&gt; restoreDeserialize(annotationClass) Restores the deserialize function back to the default. Parameters: Name Type Description annotationClass Core.Annotations.Annotation The class (constructor) of the annotation &lt;static&gt; restoreDraw(annotationClass) Restores the draw function back to the default. Parameters: Name Type Description annotationClass Core.Annotations.Annotation The class (constructor) of the annotation &lt;static&gt; restoreSerialize(annotationClass) Restores the serialize function back to the default. Parameters: Name Type Description annotationClass Core.Annotations.Annotation The class (constructor) of the annotation &lt;static&gt; setCustomControlHandleDrawHandler(controlHandle, controlHandleDrawHandler) Change ControlHandle's draw to customize appearance on the provided canvas context. Parameters: Name Type Description controlHandle Core.Annotations.ControlHandle The class (constructor) of the controlHandle controlHandleDrawHandler CustomControlHandleDrawHandler The handler will customize the appearance of the controlHandle Example Annotations.setCustomControlHandleDrawHandler(Core.Annotations.ControlHandle, function(ctx, annotation, selectionBox, zoom, {controlHandle, originalDraw}) { if(controlHandle instanceof Core.Annotations.BoxControlHandle) { const dim = this.getDimensions(annotation, selectionBox, zoom); ctx.fillStyle = '#FFFFFF'; ctx.beginPath(); ctx.moveTo(dim.x1 + (dim.getWidth() / 2), dim.y1); ctx.lineTo(dim.x1 + dim.getWidth(), dim.y1 + dim.getHeight()); ctx.lineTo(dim.x1, dim.y1 + dim.getHeight()); ctx.closePath(); ctx.stroke(); ctx.fill(); } else { originalDraw(ctx, annotation, selectionBox, zoom); } }) &lt;static&gt; setCustomCreateInnerElementHandler(annotationClass, createInnerElementHandler) Change createInnerElement to customize the HTML element. Parameters: Name Type Description annotationClass Core.Annotations.WidgetAnnotation The annotation being selected to change innerElement createInnerElementHandler Core.Annotations.CustomCreateInnerElementHandler Example Annotations.setCustomCreateInnerElementHandler(Annotations.CheckButtonWidgetAnnotation, function(annotationManager, {annotation, originalCreateInnerElement}){ const button = this; const el = originalCreateInnerElement(); el.addEventListener('click', () =&gt; { console.log('check button clicked', annotation.fieldName); }); return el; }) &lt;static&gt; setCustomCreateSignHereElementHandler(createSignHereElementHandler) Change createSignHereElement to customize the HTML element. Parameters: Name Type Description createSignHereElementHandler Core.Annotations.CustomCreateSignHereElementHandler Example Annotations.setCustomCreateSignHereElementHandler(function(tool, {annotation, originalCreateSignHereElement}) { const signHereElement = originalCreateSignHereElement(tool); signHereElement.style.background = \"red\"; return signHereElement; }) &lt;static&gt; setCustomDeserializeHandler(annotationClass, deserializeHandler) Changes how an annotation type is deserialized within WebViewer. If your custom property/attribute is stored in the CustomData, please consider using getCustomData instead. Parameters: Name Type Description annotationClass Core.Annotations.Annotation The class (constructor) of the annotation deserializeHandler Core.Annotations.CustomAnnotationDeserializeHandler A handler function that will deserialize the annotation Example Annotations.setCustomDeserializeHandler(Annotations.RectangleAnnotation, function(element, pageMatrix, options) { const annot = options.annotation; options.originalDeserialize(element, pageMatrix) if (annot.Width &gt; 100) { annot.myProperty = element.getAttribute('myAttr'); } }); &lt;static&gt; setCustomDrawHandler(annotationClass, drawHandler [, options]) Changes how an annotation type is drawn within WebViewer. By default, this will also generate an appearance for the annotation when the document is downloaded, so it will appear the same in other viewers. Please note that changes to the annotation may cause the appearance to be discarded, reverting it back to normal. Please note that NoZoom annotations do render slightly differently from standard annotations. Nonetheless, please draw at the annotation coordinates. The appearance set by addCustomAppearance will take priority. Parameters: Name Type Argument Description annotationClass Core.Annotations.Annotation The class (constructor) of the annotation drawHandler Core.Annotations.CustomAnnotationDrawHandler A handler function that will draw the annotation options Core.Annotations.CustomDrawOptions &lt;optional&gt; Optional options Properties Name Type Argument Description generateAppearance boolean &lt;optional&gt; Whether to generate a custom appearance. Defaults to true canvasMultiplier number &lt;optional&gt; The quality value of the generated custom appearance. The higher the value, the more memory is required. By default, this will use the canvas multiplier value set in WebViewer Example Annotations.setCustomDrawHandler(Annotations.RectangleAnnotation, function(ctx, pageMatrix, rotation, options) { options.originalDraw(ctx, pageMatrix); // Draw original annotation const annot = options.annotation; // Draw annotation ID overtop the rectangle ctx.fillStyle = '#FF0000'; ctx.strokeStyle = '#000000'; const fontSize = 12; ctx.fillText(annot.Id, annot.X, annot.Y + fontSize); // Draw at annotation location ctx.strokeText(annot.Id, annot.X, annot.Y + fontSize); }); &lt;static&gt; setCustomSerializeHandler(annotationClass, serializeHandler) Changes how an annotation type is serialized within WebViewer. Note that custom attributes will not be persisted in the downloaded PDF and are only useful if you're saving the XFDF separately from the PDF. If you are looking to save your custom property/attribute, please consider using setCustomData which will be persisted. Parameters: Name Type Description annotationClass Core.Annotations.Annotation The class (constructor) of the annotation serializeHandler Core.Annotations.CustomAnnotationSerializeHandler A handler function that will serialize the annotation Example Annotations.setCustomSerializeHandler(Annotations.RectangleAnnotation, function(element, pageMatrix, options) { const annot = options.annotation; options.originalSerialize(element, pageMatrix) if (annot.Width &gt; 100) { element.setAttribute('myAttr', 1); } return element; }); Type Definitions AnnotationDrawFunction(ctx, pageMatrix [, rotation]) Annotation draw function signature. Parameters: Name Type Argument Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on rotation number &lt;optional&gt; Certain annotations, such as sticky notes, get rotation as a third parameter. Default: undefined CustomAnnotationDeserializeHandler(element, pageMatrix, options) Callback that gets passed to deserializeHandler in setCustomDeserializeHandler. The signature is similar to deserialize except with an additional options parameter. Parameters: Name Type Description element Element An xml element representing the annotation pageMatrix object The page matrix used to convert PDF coordinates to viewer coordinates options object Additional options and parameters Properties Name Type Description annotation Core.Annotations.Annotation The annotation being deserialized originalDeserialize function The original deserialize function of this annotation CustomAnnotationDrawHandler(ctx, pageMatrix, rotation, options) Callback that gets passed to drawHandler in setCustomDrawHandler. The signature is similar to draw except with an additional options parameter. Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on rotation number Certain annotations, such as sticky notes, get rotation as a third parameter. Default: undefined options Core.Annotations.AdditionalOptions Additional options and parameters Properties Name Type Description annotation Core.Annotations.Annotation The annotation being drawn originalDraw Core.Annotations.AnnotationDrawFunction The original draw function of this annotation CustomAnnotationSerializeHandler(element, pageMatrix, options) Callback that gets passed to serializeHandler in setCustomSerializeHandler. The signature is similar to serialize except with an additional options parameter. Parameters: Name Type Description element Element An xml element representing the annotation pageMatrix object The page matrix used to convert PDF coordinates to viewer coordinates options object Additional options and parameters Properties Name Type Description annotation Core.Annotations.Annotation The annotation being serialized originalSerialize function The original serialize function of this annotation Returns: The resulting xml element representing the annotation Type Element CustomControlHandleDrawHandler(ctx, annotation, selectionBox, zoom, options) Callback that gets passed to controlHandleDrawHandler in setCustomControlHandleDrawHandler. The signature is similar to draw except with an additional options parameter. Parameters: Name Type Description ctx CanvasRenderingContext2D The annotation canvas context annotation Core.Annotations.Annotation The annotation to modify selectionBox Core.Math.Rect The selection rect zoom number The current zoom level of the document options object Additional options and parameters Properties Name Type Description controlHandle Core.Annotations.ControlHandle The selected controlHandle instance originalDraw function The original draw function of the controlHandle CustomCreateInnerElementHandler(annotationManager, options) Callback that gets passed to createInnerElementHandler in setCustomCreateInnerElementHandler. The signature is similar to createInnerElement except with an additional options parameter. Parameters: Name Type Description annotationManager Core.AnnotationManager options object Additional options and parameters Properties Name Type Description annotation Core.Annotations.WidgetAnnotation The annotation being selected to change innerElement originalCreateInnerElement function The original createInnerElement function of this annotation Returns: An HTML element Type HTMLElement CustomCreateSignHereElementHandler(signatureTool, options) Callback that gets passed to createSignHereElementHandler in setCustomCreateSignHereElementHandler. The signature is similar to createSignHereElement except with an additional options parameter. Parameters: Name Type Description signatureTool Core.Tools.SignatureCreateTool The tool that create signature annotation widget options object Additional options and parameters Properties Name Type Description annotation Core.Annotations.SignatureWidgetAnnotation The annotation being selected to create sign here element originalCreateSignHereElement function The original createSignHereElement function of this annotation Returns: An HTML element Type HTMLElement measurementCaptionOptions Type: Object Properties: Name Type Argument Description isEnabled boolean The flag for enabling or disabling measurement captions on the annotation. captionRect Core.Math.Rect &lt;optional&gt; The caption's text bounding rect. The bounding rect will be auto-adjusted to the annotation's visual center if the annotation is resized. captionStyle.color string &lt;optional&gt; The caption's text color. Default to measurement annotation's color when not set. Accepts CSS HEX or CSS RGBA values. captionStyle.staticSize string &lt;optional&gt; The static size for caption text. This option is ignored when it's set to 0pt. captionStyle.maximumSize string &lt;optional&gt; The maximum caption text size. This option is ignored when it's set to 0pt or when staticSize is set to positive values. × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Annotations.Annotation.html":{"id":"Core.Annotations.Annotation.html","title":"Class: Annotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Annotation Core.Annotations. Annotation Represents an annotation. new Annotation( [initializer]) The base class for all annotations Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Members &lt;static&gt; MeasurementDisplayFormats An object containing the different display formats for measurement annotations. Type: string Properties: Name Type Description DECIMAL string Decimal format eg. 12.75 FRACTION string Decimal format eg. 12 3/4 ROUND string Decimal format eg. 12.8 TRUNCATE string Decimal format eg. 12.7 Example const fractionMeasurementDisplayFormat = Annotations.Annotation.MeasurementDisplayFormats.FRACTION &lt;static&gt; MeasurementSystems An object containing the different measurement systems for measurement annotations. Type: string Properties: Name Type Description METRIC string The Metric measurement system IMPERIAL string The Imperial measurement system TYPOGRAPHIC string The Typographic measurement system Example const metricMeasurementSystem = Annotations.Annotation.MeasurementSystems.METRIC &lt;static&gt; MeasurementUnits An object containing the different display measurement units for measurement annotations. Type: string Properties: Name Type Description MM string Millimeter measurement unit CM string Centimeter measurement unit M string Meter measurement unit KM string Kilometer measurement unit IN string Inch measurement unit FT string Foot measurement unit YD string Yard measurement unit MI string Mile measurement unit PT string Point measurement unit DOUBLE_PRIME_IN string Inch\" measurement unit PRIME_FT string Foot' measurement unit FT_IN string Foot and Inch measurement unit Example const centimeterMeasurementUnit = Annotations.Annotation.MeasurementUnits.CM Author The author of the annotation. Type: string Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color DateModified Gets or sets the date that the annotation was last modified. Type: Date elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Height Gets or sets the height of the annotation. Type: number Hidden Gets or sets whether the annotation is hidden. Type: boolean Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean NoDelete Gets or sets if this annotation can be deleted. Type: boolean NoMove Gets or sets whether or not the annotation can be moved. Type: boolean NoResize Gets or sets if this annotation can be resized by the user. Type: boolean NoRotate Gets or sets if this annotation can be rotated. Type: boolean NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean NoZoom Gets or sets if this annotation scales with the page. Type: boolean PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean ReplyType The type of reply. Type: string Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Subject Represents the subject of the annotation. Default is the annotation's type. Type: string ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean ToolName The name of the tool that is used to create this annotation. Type: string Width Gets or sets the width of the annotation. Type: number X Gets or sets the annotation's x-axis position. Type: number Y Gets or sets the annotation's y-axis position. Type: number Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. disableRotationControl() Disables the rotation control for the annotation draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. enableRotationControl() Enables the rotation control for the annotation getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Returns: The last status update. Type string getWidth() Gets the width of the annotation. Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Returns: the x position Type number getY() Gets the y position measured in page coordinates. Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle removeCustomAppearance() Removes the custom appearance of the annotation. resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Type Definitions RichTextCSSStyle Type: Object Properties: Name Type Argument Description 'font-style' 'normal' | 'italic' &lt;optional&gt; 'font-weight' 'normal' | 'bold' &lt;optional&gt; 'text-decoration' 'word' | 'line-through' | 'underline' | string &lt;optional&gt; text-decoration: 'word' is equivalent to text-decoration: 'underline'. Values of text-decorations can also be joined by a space. For example, text-decoration: 'word line-through' color string &lt;optional&gt; color in RGB hex format RichTextStyle an object that maps between a text style location(character index) to css styles. Type: Object.&lt;string, Core.Annotations.Annotation.RichTextCSSStyle&gt; Example { 0: { 'font-weight': 'bold', 'color': '#ff0000', }, 10: { 'font-style': 'italic' 'font-weight': 'bold', 'color': '#0000ff', }, 12: { 'text-decoration': 'underline', } } this object means that the first 9 characters are bold and red, the following 2 characters are italic, bold, and blue, and the rest of characters have underline. × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Annotations.ArcAnnotation.html":{"id":"Core.Annotations.ArcAnnotation.html","title":"Class: ArcAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: ArcAnnotation Core.Annotations. ArcAnnotation new ArcAnnotation( [initializer]) Represents a Arc annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.IPathAnnotation Members Angle Gets the current Sweep Angle in degrees. Type: string Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color Dashes Gets or sets the border dash style of an annotation. e.g '3' or '3,3' Type: string DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified DisplayFormat Gets or sets the annotation's measurement display format. Type: string Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementDisplayFormats = Annotations.Annotation.MeasurementDisplayFormats measurementAnnotation.DisplayFormat = measurementDisplayFormats.FRACTION }); DisplayUnits Gets or sets the annotation's measurement display units. Type: Array.&lt;string&gt; Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementUnits = Annotations.Annotation.MeasurementUnits measurementAnnotation.DisplayUnits = [measurementUnits.FT, measurementUnits.IN] }); elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Length Gets the current length. Type: string Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Path Gets or Sets the 3 points defining the Arc. Type: string Precision Gets or sets the annotation's precision from its measure dictionary. Type: number Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementDisplayFormats = Annotations.Annotation.MeasurementDisplayFormats measurementAnnotation.DisplayFormat = measurementDisplayFormats.FRACTION }); Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable Properties Gets all the measurement properties of the Arc. Type: string Radius Gets the current Radius. Type: string ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled Scale Gets or sets the annotation's scale from its measure dictionary. Type: Array.&lt;any&gt; selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Style Gets or sets the border style of an annotation. e.g Solid, Cloudy Type: string Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject System Gets or sets the annotation's system (Metric, Imperial, Typographic). Type: string Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementSystems = Annotations.Annotation.MeasurementSystems measurementAnnotation.System = measurementSystems.METRIC ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName Type Gets the annotations current type. Type: string ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance addPathPoint(x, y) Adds a point to the path Parameters: Name Type Description x number The x coordinate of the point y number The y coordinate of the point Inherited From: Core.Annotations.IPathAnnotation#addPathPoint adjustRect() Recalculate the width and height of the annotation Inherited From: Core.Annotations.IPathAnnotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getPath() Gets the path array Inherited From: Core.Annotations.IPathAnnotation#getPath Returns: The array of path points Type Array.&lt;Core.Math.Point&gt; getPathPoint(index) Gets the point in the path at the specified index Parameters: Name Type Description index number The index in the path array Inherited From: Core.Annotations.IPathAnnotation#getPathPoint Returns: The path point as an object with x and y properties Type object getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move popPath() Removes the last point from the path Inherited From: Core.Annotations.IPathAnnotation#popPath Returns: The path point as an object with x and y properties Type object removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; rotate(angle, rotationPoint) Rotate the annotation by angle and origin point to rotate around. Parameters: Name Type Description angle number The angle in radians rotationPoint Core.Math.Point The rotation point to do the rotation around. The default is the center point of the annotation Inherited From: Core.Annotations.IPathAnnotation#rotate serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setPathPoint(index, x, y) Sets the path point at a specific index Parameters: Name Type Description index number The index in the path array to set x number The x coordinate of the point y number The y coordinate of the point Inherited From: Core.Annotations.IPathAnnotation#setPathPoint setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Annotations.Border.html":{"id":"Core.Annotations.Border.html","title":"Class: Border","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Border Core.Annotations. Border Represents a class that contains border information for an annotation. new Border(options) Creates a new instance of Border. Parameters: Name Type Description options object The initialization options, an object with properties color, width, style, cornerRadius Properties: Name Type Description color Core.Annotations.Color The color of the border width number The width of the border style string The style of the border (possible types include: solid, bevelled, inset) cornerRadius number The corner radius size × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Annotations.BoxControlHandle.html":{"id":"Core.Annotations.BoxControlHandle.html","title":"Class: BoxControlHandle","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: BoxControlHandle Core.Annotations. BoxControlHandle A control handle based on the bounding box of the annotation used for resizing. new BoxControlHandle(width, height, horizontalAlignment, verticalAlignment) Creates a new box control handle Parameters: Name Type Description width number the width of the handle height number the height of the handle horizontalAlignment number the horizontal position of the handle verticalAlignment number the vertical position of the handle Extends Core.Annotations.ControlHandle Methods draw(ctx, annotation, selectionBox, zoom) Draws the control handle's appearance on the provided canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D the annotation canvas context annotation Core.Annotations.Annotation the annotation to modify selectionBox Core.Math.Rect the selection rect zoom number the current zoom level of the document Inherited From: Core.Annotations.ControlHandle#draw testSelection(annotation, selectionBox, zoom, x, y) Determines if the provided point is a hit on the control handle. See Core.Annotations.SelectionAlgorithm for usuable selection algorithms. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation selectionBox Core.Math.Rect the selection rect zoom number the current zoom level of the document x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates Inherited From: Core.Annotations.ControlHandle#testSelection Returns: true if the provided point is a hit Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Annotations.BoxSelectionModel.html":{"id":"Core.Annotations.BoxSelectionModel.html","title":"Class: BoxSelectionModel","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: BoxSelectionModel Core.Annotations. BoxSelectionModel A selection model based on the annotation's bounding box. This is used for most generic annotations. new BoxSelectionModel(annotation, canModify, isSelected) Creates a box selection model. Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation canModify boolean Indicates if the annotation can be modified isSelected boolean boolean to denote if the annotation is selected Extends Core.Annotations.SelectionModel Methods canModify() Indicates that the associated annotation is able to be modified Inherited From: Core.Annotations.SelectionModel#canModify Returns: Type boolean drawSelectionOutline(ctx, annotation, zoom) Draws the selection outline of the annotation. By default, a rectangle is drawn based on the annotations x, y, width and height. Parameters: Name Type Description ctx CanvasRenderingContext2D annotation Core.Annotations.Annotation zoom number Inherited From: Core.Annotations.SelectionModel#drawSelectionOutline getControlHandles() Returns the ControlHandle objects associated with this selection model. Inherited From: Core.Annotations.SelectionModel#getControlHandles Returns: An array of ControlHandleObject Type Array.&lt;Core.Annotations.ControlHandle&gt; getDimensions(annotation) Gets the dimensions {x, y, width, height} of the selection bounding box. It may be different from the annotation's bounding box. e.g. The selection bounding box may have a padding. Parameters: Name Type Description annotation Core.Annotations.Annotation Inherited From: Core.Annotations.SelectionModel#getDimensions Returns: Type Core.Math.Rect isSelected() Indicates that the associated annotation is already selected. This can be useful to implement different selection behaviors when an annotation is selected. Inherited From: Core.Annotations.SelectionModel#isSelected Overrides: Core.Annotations.SelectionModel#isSelected Returns: Type boolean testControlHandles(annotation, zoom, x, y) Hit detection for each control handle. Parameters: Name Type Description annotation Core.Annotations.Annotation zoom number x number y number Inherited From: Core.Annotations.SelectionModel#testControlHandles Returns: The control handle that was hit Type Core.Annotations.ControlHandle testSelection(annotation, x, y, pageMatrix, zoom, rotation) Determines if the provided point is a hit on the selected annotationhandle. * See Core.Annotations.SelectionAlgorithm for usuable selection algorithms. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates pageMatrix object the page matrix of the page the annotation is on zoom number the zoom level of the page the annotation is on rotation Core.PageRotation the rotation of the page the annotation is on Inherited From: Core.Annotations.SelectionModel#testSelection Returns: true if the provided point is a hit Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Annotations.ButtonWidgetAnnotation.html":{"id":"Core.Annotations.ButtonWidgetAnnotation.html","title":"Class: ButtonWidgetAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: ButtonWidgetAnnotation Core.Annotations. ButtonWidgetAnnotation Represents a Button Widget annotation, which includes push button, checkbox, and radio button. new ButtonWidgetAnnotation(field, options) Creates a new instance of ButtonWidgetAnnotation. Parameters: Name Type Argument Description field Core.Annotations.Forms.Field The field to associate with the widget options object &lt;nullable&gt; A map of properties to set on the widget Extends Core.Annotations.WidgetAnnotation Members &lt;static&gt; WidgetButtonCaptions An enum for each checkbox/radioButton caption values When assgin the enum to checkbox/radioButton caption, the UI of the checkbox/radioButton will be changed to the corresponded shape Type: string Properties: Name Type Description CROSS string name of Cross shape TICK string name of Tick shape CIRCLE string name of Circle shape DIAMAND string name of Diamand shape SQUARE string name of Square shape STAR string name of Star shape Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect createInnerElement() Returns the HTML element of a widget annotation. Override this method to customize the HTML element. Inherited From: Core.Annotations.HTMLAnnotation#createInnerElement Returns: a HTML element Type HTMLElement deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getField() Gets the widget's associated field. Inherited From: Core.Annotations.WidgetAnnotation#getField Returns: The widget's field. Type Core.Annotations.Forms.Field getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getValue() Get the widget's value. Inherited From: Core.Annotations.WidgetAnnotation#getValue Returns: The widget's value (potentially formatted). Type string | number getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element set(options) Set all properties on this widget. Parameters: Name Type Description options Core.Annotations.WidgetAnnotation The set of parameters to set Inherited From: Core.Annotations.WidgetAnnotation#set setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setField(field) Sets the widget's associated field. Parameters: Name Type Description field Core.Annotations.Forms.Field The new field to associate with the widget. Inherited From: Core.Annotations.WidgetAnnotation#setField setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setValue(value) Set and format the widget's value. Parameters: Name Type Argument Description value string | number &lt;nullable&gt; The new value to set Inherited From: Core.Annotations.WidgetAnnotation#setValue setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Annotations.CalloutControlHandle.html":{"id":"Core.Annotations.CalloutControlHandle.html","title":"Class: CalloutControlHandle","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: CalloutControlHandle Core.Annotations. CalloutControlHandle A control handle for the callout Core.Annotations.FreeTextAnnotation annotation. The annotation must implement the getPath() method. new CalloutControlHandle(x, y, width, height, pathIndex) Creates a callout control handle. Parameters: Name Type Description x number the x coordinate of the point y number the y coordinate of the point width number the width of the handle height number the height of the handle pathIndex number the index of the point in the path array Extends Core.Annotations.ControlHandle Methods draw(ctx, annotation, selectionBox, zoom) Draws the control handle's appearance on the provided canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D the annotation canvas context annotation Core.Annotations.Annotation the annotation to modify selectionBox Core.Math.Rect the selection rect zoom number the current zoom level of the document Inherited From: Core.Annotations.ControlHandle#draw testSelection(annotation, selectionBox, zoom, x, y) Determines if the provided point is a hit on the control handle. See Core.Annotations.SelectionAlgorithm for usuable selection algorithms. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation selectionBox Core.Math.Rect the selection rect zoom number the current zoom level of the document x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates Inherited From: Core.Annotations.ControlHandle#testSelection Returns: true if the provided point is a hit Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Annotations.CalloutSelectionModel.html":{"id":"Core.Annotations.CalloutSelectionModel.html","title":"Class: CalloutSelectionModel","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: CalloutSelectionModel Core.Annotations. CalloutSelectionModel A selection model for FreeTextAnnotation callouts. new CalloutSelectionModel(annotation, canModify, isSelected, docViewer) Creates a callout selection model. Parameters: Name Type Description annotation Core.Annotations.FreeTextAnnotation The annotation canModify boolean Indicates if the annotation can be modified isSelected boolean The annotation is already selected docViewer Core.DocumentViewer An instance of DocumentViewer. × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Annotations.CanvasHelper.html":{"id":"Core.Annotations.CanvasHelper.html","title":"Class: CanvasHelper","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: CanvasHelper Core.Annotations. CanvasHelper new CanvasHelper(canvas) A wrapper helper for drawing to HTML canvases. Parameters: Name Type Description canvas HTMLCanvasElement | CanvasRenderingContext2D The canvas or canvas context to draw to Methods clear() Clears the canvas. Returns: The current instance Type CanvasHelper drawCircle(rect [, drawingParameters]) Draws a circle in the provided rectangle on the canvas. Parameters: Name Type Argument Description rect Core.Math.Rect The rect where the circle will be drawn drawingParameters object &lt;optional&gt; Additional drawing parameters. Values are acceptable HTML canvas values Properties Name Type Argument Description fillColor Core.Annotations.Color &lt;optional&gt; Fill color borderColor Core.Annotations.Color &lt;optional&gt; Border or stroke color borderStyle string &lt;optional&gt; Either 'solid' or 'dash'. Default: solid borderWidth number &lt;optional&gt; The border width dashes Array.&lt;number&gt; &lt;optional&gt; Array of dash size and spacing ex. [4, 3]. Default: [3] opacity number &lt;optional&gt; Opacity value. Default: 1 clipPath boolean &lt;optional&gt; Whether to clip the path. Default: false transform Core.Math.Matrix &lt;optional&gt; Drawing transformation isStateful boolean &lt;optional&gt; Whether to undo canvas context changes after rendering. Default: true forceFill boolean &lt;optional&gt; Whether to fill the shape regardless of whether a fill color is passed. This would use the currently set fillStyle on the canvas context. Default: false forceStroke boolean &lt;optional&gt; Whether to stroke the shape regardless of whether a stroke color is passed. This would use the currently set strokeStyle on the canvas context. Default: false Returns: The current instance Type CanvasHelper drawCircleXY(cx, cy, radius [, drawingParameters]) Draws a circle in the provided rectangle on the canvas. Parameters: Name Type Argument Description cx number The x-coordinate of the circles center cy number The rect where the circle will be drawn radius number The radius of the circle drawingParameters object &lt;optional&gt; Additional drawing parameters. Values are acceptable HTML canvas values Properties Name Type Argument Description fillColor Core.Annotations.Color &lt;optional&gt; Fill color borderColor Core.Annotations.Color &lt;optional&gt; Border or stroke color borderStyle string &lt;optional&gt; Either 'solid' or 'dash'. Default: solid borderWidth number &lt;optional&gt; The border width dashes Array.&lt;number&gt; &lt;optional&gt; Array of dash size and spacing ex. [4, 3]. Default: [3] opacity number &lt;optional&gt; Opacity value. Default: 1 clipPath boolean &lt;optional&gt; Whether to clip the path. Default: false transform Core.Math.Matrix &lt;optional&gt; Drawing transformation isStateful boolean &lt;optional&gt; Whether to undo canvas context changes after rendering. Default: true forceFill boolean &lt;optional&gt; Whether to fill the shape regardless of whether a fill color is passed. This would use the currently set fillStyle on the canvas context. Default: false forceStroke boolean &lt;optional&gt; Whether to stroke the shape regardless of whether a stroke color is passed. This would use the currently set strokeStyle on the canvas context. Default: false Returns: The current instance Type CanvasHelper drawClouds(annot, points [, drawingParameters]) Draws a cloud shape provided by the points on the canvas. Parameters: Name Type Argument Description annot Core.Annotations.Annotation The annotation being drawn points Array.&lt;Core.Math.Point&gt; An array of points that represents a shape drawingParameters object &lt;optional&gt; Additional drawing parameters. Values are acceptable HTML canvas values Properties Name Type Argument Description fillColor Core.Annotations.Color &lt;optional&gt; Fill color borderColor Core.Annotations.Color &lt;optional&gt; Border or stroke color borderStyle string &lt;optional&gt; Either 'solid' or 'dash'. Default: solid borderWidth number &lt;optional&gt; The border width dashes Array.&lt;number&gt; &lt;optional&gt; Array of dash size and spacing ex. [4, 3]. Default: [3] opacity number &lt;optional&gt; Opacity value. Default: 1 closePath boolean &lt;optional&gt; Whether automatically close the path between the first and last points. Default: true clipPath boolean &lt;optional&gt; Whether to clip the path. Default: false transform Core.Math.Matrix &lt;optional&gt; Drawing transformation isStateful boolean &lt;optional&gt; Whether to undo canvas context changes after rendering. Default: true forceFill boolean &lt;optional&gt; Whether to fill the shape regardless of whether a fill color is passed. This would use the currently set fillStyle on the canvas context. Default: false forceStroke boolean &lt;optional&gt; Whether to stroke the shape regardless of whether a stroke color is passed. This would use the currently set strokeStyle on the canvas context. Default: false Returns: The current instance Type CanvasHelper drawLine(start, end [, drawingParameters]) Draws a line using two points on the canvas. Parameters: Name Type Argument Description start Core.Math.Point The start point end Core.Math.Point The end point drawingParameters object &lt;optional&gt; Additional drawing parameters. Values are acceptable HTML canvas values Properties Name Type Argument Description color Core.Annotations.Color &lt;optional&gt; The line color borderStyle string &lt;optional&gt; Either 'solid' or 'dash'. Default: solid borderWidth number &lt;optional&gt; The border width dashes Array.&lt;number&gt; &lt;optional&gt; Array of dash size and spacing ex. [4, 3]. Default: [3] transform Core.Math.Matrix &lt;optional&gt; Drawing transformation isStateful boolean &lt;optional&gt; Whether to undo canvas context changes after rendering. Default: true forceFill boolean &lt;optional&gt; Whether to fill the shape regardless of whether a fill color is passed. This would use the currently set fillStyle on the canvas context. Default: false forceStroke boolean &lt;optional&gt; Whether to stroke the shape regardless of whether a stroke color is passed. This would use the currently set strokeStyle on the canvas context. Default: false Returns: The current instance Type CanvasHelper drawLineXY(sx, sy, dx, dy [, drawingParameters]) Draws a line using two points on the canvas. Parameters: Name Type Argument Description sx number The start x-coordinate sy number The start y-coordinate dx number The end x-coordinate dy number The end y-coordinate drawingParameters object &lt;optional&gt; Additional drawing parameters. Values are acceptable HTML canvas values Properties Name Type Argument Description color Core.Annotations.Color &lt;optional&gt; The line color borderStyle string &lt;optional&gt; Either 'solid' or 'dash'. Default: solid borderWidth number &lt;optional&gt; The border width dashes Array.&lt;number&gt; &lt;optional&gt; Array of dash size and spacing ex. [4, 3]. Default: [3] transform Core.Math.Matrix &lt;optional&gt; Drawing transformation isStateful boolean &lt;optional&gt; Whether to undo canvas context changes after rendering. Default: true forceFill boolean &lt;optional&gt; Whether to fill the shape regardless of whether a fill color is passed. This would use the currently set fillStyle on the canvas context. Default: false forceStroke boolean &lt;optional&gt; Whether to stroke the shape regardless of whether a stroke color is passed. This would use the currently set strokeStyle on the canvas context. Default: false Returns: The current instance Type CanvasHelper drawPolygon(points [, drawingParameters]) Draws a shape provided by the points on the canvas. Parameters: Name Type Argument Description points Array.&lt;Core.Math.Point&gt; An array of points that represents a shape drawingParameters object &lt;optional&gt; Additional drawing parameters. Values are acceptable HTML canvas values Properties Name Type Argument Description fillColor Core.Annotations.Color &lt;optional&gt; Fill color borderColor Core.Annotations.Color &lt;optional&gt; Border or stroke color borderStyle string &lt;optional&gt; Either 'solid' or 'dash'. Default: solid borderWidth number &lt;optional&gt; The border width dashes Array.&lt;number&gt; &lt;optional&gt; Array of dash size and spacing ex. [4, 3]. Default: [3] opacity number &lt;optional&gt; Opacity value. Default: 1 closePath boolean &lt;optional&gt; Whether automatically close the path between the first and last points. Default: true clipPath boolean &lt;optional&gt; Whether to clip the path. Default: false transform Core.Math.Matrix &lt;optional&gt; Drawing transformation isStateful boolean &lt;optional&gt; Whether to undo canvas context changes after rendering. Default: true forceFill boolean &lt;optional&gt; Whether to fill the shape regardless of whether a fill color is passed. This would use the currently set fillStyle on the canvas context. Default: false forceStroke boolean &lt;optional&gt; Whether to stroke the shape regardless of whether a stroke color is passed. This would use the currently set strokeStyle on the canvas context. Default: false Returns: The current instance Type CanvasHelper drawRectangle(rect [, drawingParameters]) Draws the rectangle to a location on the canvas. Parameters: Name Type Argument Description rect Core.Math.Rect The rect to be drawn drawingParameters object &lt;optional&gt; Additional drawing parameters. Values are acceptable HTML canvas values Properties Name Type Argument Description fillColor Core.Annotations.Color &lt;optional&gt; Fill color borderColor Core.Annotations.Color &lt;optional&gt; Border or stroke color borderStyle string &lt;optional&gt; Either 'solid' or 'dash'. Default: solid borderWidth number &lt;optional&gt; The border width dashes Array.&lt;number&gt; &lt;optional&gt; Array of dash size and spacing ex. [4, 3]. Default: [3] opacity number &lt;optional&gt; Opacity value. Default: 1 clipPath boolean &lt;optional&gt; Whether to clip the path. Default: false transform Core.Math.Matrix &lt;optional&gt; Drawing transformation isStateful boolean &lt;optional&gt; Whether to undo canvas context changes after rendering. Default: true forceFill boolean &lt;optional&gt; Whether to fill the shape regardless of whether a fill color is passed. This would use the currently set fillStyle on the canvas context. Default: false forceStroke boolean &lt;optional&gt; Whether to stroke the shape regardless of whether a stroke color is passed. This would use the currently set strokeStyle on the canvas context. Default: false Returns: The current instance Type CanvasHelper drawText(text, x, y [, drawingParameters]) Draws the text to a location on the canvas. Parameters: Name Type Argument Description text string The text to be drawn x number The x-coordinate y number The y-coordinate drawingParameters object &lt;optional&gt; Additional drawing parameters. Values are acceptable HTML canvas values Properties Name Type Argument Description fillColor Core.Annotations.Color &lt;optional&gt; Fill color borderColor Core.Annotations.Color &lt;optional&gt; Border or stroke color borderStyle string &lt;optional&gt; Either 'solid' or 'dash'. Default: solid borderWidth number &lt;optional&gt; The border width dashes Array.&lt;number&gt; &lt;optional&gt; Array of dash size and spacing ex. [4, 3]. Default: [3] fontSize number &lt;optional&gt; Size of font. Default: 10 fontSizeUnits string &lt;optional&gt; Font units. Default: pt fontWeight string &lt;optional&gt; Font boldness. Default: normal fontStyle string &lt;optional&gt; Font style. Default: normal fontFamily string &lt;optional&gt; List of font-families. Default: sans-serif opacity number &lt;optional&gt; Opacity value. Default: 1 transform Core.Math.Matrix &lt;optional&gt; Drawing transformation isStateful boolean &lt;optional&gt; Whether to undo canvas context changes after rendering. Default: true forceFill boolean &lt;optional&gt; Whether to fill the shape regardless of whether a fill color is passed. This would use the currently set fillStyle on the canvas context. Default: false forceStroke boolean &lt;optional&gt; Whether to stroke the shape regardless of whether a stroke color is passed. This would use the currently set strokeStyle on the canvas context. Default: false Returns: The current instance Type CanvasHelper measureText(text [, options]) Measures the width of the text given the string and additional information. Parameters: Name Type Argument Description text string The text to be drawn options object &lt;optional&gt; Additional drawing parameters. Values are acceptable HTML canvas values Properties Name Type Argument Description fontSize number &lt;optional&gt; Size of font. Default: 10 fontSizeUnits string &lt;optional&gt; Font units. Default: pt fontWeight string &lt;optional&gt; Font boldness. Default: normal fontStyle string &lt;optional&gt; Font style. Default: normal fontFamily string &lt;optional&gt; List of font-families. Default: sans-serif Returns: The measured text info Type TextMetrics × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:41-07:00 using the DocStrap template. "},"Core.Annotations.CaretAnnotation.html":{"id":"Core.Annotations.CaretAnnotation.html","title":"Class: CaretAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: CaretAnnotation Core.Annotations. CaretAnnotation new CaretAnnotation( [initializer]) Represents a caret annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.MarkupAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.CheckButtonWidgetAnnotation.html":{"id":"Core.Annotations.CheckButtonWidgetAnnotation.html","title":"Class: CheckButtonWidgetAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: CheckButtonWidgetAnnotation Core.Annotations. CheckButtonWidgetAnnotation new CheckButtonWidgetAnnotation(field, options) A Checkbutton widget annotation. Parameters: Name Type Argument Description field Core.Annotations.Forms.Field The field to associate with the widget options object &lt;nullable&gt; A map of properties to set on the widget Extends Core.Annotations.ButtonWidgetAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect createInnerElement() Returns the HTML element of a widget annotation. Override this method to customize the HTML element. Inherited From: Core.Annotations.HTMLAnnotation#createInnerElement Returns: a HTML element Type HTMLElement deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getField() Gets the widget's associated field. Inherited From: Core.Annotations.WidgetAnnotation#getField Returns: The widget's field. Type Core.Annotations.Forms.Field getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getValue() Get the widget's value. Inherited From: Core.Annotations.WidgetAnnotation#getValue Returns: The widget's value (potentially formatted). Type string | number getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element set(options) Set all properties on this widget. Parameters: Name Type Description options Core.Annotations.WidgetAnnotation The set of parameters to set Inherited From: Core.Annotations.WidgetAnnotation#set setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setField(field) Sets the widget's associated field. Parameters: Name Type Description field Core.Annotations.Forms.Field The new field to associate with the widget. Inherited From: Core.Annotations.WidgetAnnotation#setField setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setValue(value) Set and format the widget's value. Parameters: Name Type Argument Description value string | number &lt;nullable&gt; The new value to set Inherited From: Core.Annotations.WidgetAnnotation#setValue setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.ChoiceWidgetAnnotation.html":{"id":"Core.Annotations.ChoiceWidgetAnnotation.html","title":"Class: ChoiceWidgetAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: ChoiceWidgetAnnotation Core.Annotations. ChoiceWidgetAnnotation Represents a Choice Widget annotation (a combo box). new ChoiceWidgetAnnotation(field, options) Creates a new instance of ChoiceWidgetAnnotation. Parameters: Name Type Argument Description field Annotations.Forms.Field The field to associate with the widget options object &lt;nullable&gt; A map of properties to set on the widget Properties: Name Type Description FORCE_SELECT boolean Whether to force all choice widgets to be html select elements Extends Core.Annotations.WidgetAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect createInnerElement() Returns the HTML element of a widget annotation. Override this method to customize the HTML element. Inherited From: Core.Annotations.HTMLAnnotation#createInnerElement Returns: a HTML element Type HTMLElement deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getField() Gets the widget's associated field. Inherited From: Core.Annotations.WidgetAnnotation#getField Returns: The widget's field. Type Core.Annotations.Forms.Field getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getValue() Get the widget's value. Inherited From: Core.Annotations.WidgetAnnotation#getValue Returns: The widget's value (potentially formatted). Type string | number getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element set(options) Set all properties on this widget. Parameters: Name Type Description options Core.Annotations.WidgetAnnotation The set of parameters to set Inherited From: Core.Annotations.WidgetAnnotation#set setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setField(field) Sets the widget's associated field. Parameters: Name Type Description field Core.Annotations.Forms.Field The new field to associate with the widget. Inherited From: Core.Annotations.WidgetAnnotation#setField setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setValue(value) Set and format the widget's value. Parameters: Name Type Argument Description value string | number &lt;nullable&gt; The new value to set Inherited From: Core.Annotations.WidgetAnnotation#setValue setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.Color.html":{"id":"Core.Annotations.Color.html","title":"Class: Color","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Color Core.Annotations. Color Represents a class that contains a color's RGB and alpha value. new Color(r, g, b [, a]) Creates a new instance of Color. Parameters: Name Type Argument Description r number the R (red) value (0-255) g number the G (green) value (0-255) b number the B (blue) value (0-255) a number &lt;optional&gt; the A (alpha) value (0-1.0) Properties: Name Type Description R number the R (red) value (0-255) G number the G (green) value (0-255) B number the B (blue) value (0-255) A number the A (alpha) value (0-1.0) Methods toHexString() Returns the color as a hex string e.g. #FFFFFF Returns: The hex color string. Type string toString() Outputs the current color as a CSS3 RGB color string. Returns: The CSS3 RGB color string. Type string Example ex. \"rgb(0,0,0)\" or \"rgba(0,255,0,0.5)\" × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.ControlHandle.html":{"id":"Core.Annotations.ControlHandle.html","title":"Class: ControlHandle","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: ControlHandle Core.Annotations. ControlHandle Represents a base class for control handles for selected annotations that can be moved. Control handles are typically used to resize an annotation or other operations that modify the annotation. new ControlHandle(x, y, width, height) Creates a new ControlHandle with the specified dimensions. Parameters: Name Type Description x number The x-coordinate of the upper-left point y number The y-coordinate of the upper-left point width number The width of the control handle height number The width of the control handle Members &lt;static&gt; color Defines the color for the annotation control point. Type: Core.Annotations.Color &lt;static&gt; handleHeight Defines the height of all control handles. Default is 10. Type: number &lt;static&gt; handleWidth Defines the width of all control handles. Default is 10. Type: number &lt;static&gt; outlineColor Defines the outline color for the annotation control point. Type: Core.Annotations.Color &lt;static&gt; rotationHandleHeight Defines the height of all rotation control handles. Default is 28. Type: number &lt;static&gt; rotationHandleWidth Defines the width of all rotation control handles. Default is 28. Type: number &lt;static&gt; selectionAccuracyPadding Defines a padding for selection accuracy. Default is 1. Increase this value to make selection more forgiving. Type: number &lt;static&gt; selectionPointOutlineThickness Defines thickness of the annotation selection outline. Default is 3. Type: number &lt;static&gt; shadowBlur Defines the shadow blur for the annotation control point. Type: number &lt;static&gt; shadowColor Defines the shadow color for the annotation control point. Type: Core.Annotations.Color &lt;static&gt; shadowOffsetY Defines the offset Y position for the shadow blur for the annotation control point. Type: number Methods draw(ctx, annotation, selectionBox, zoom) Draws the control handle's appearance on the provided canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D the annotation canvas context annotation Core.Annotations.Annotation the annotation to modify selectionBox Core.Math.Rect the selection rect zoom number the current zoom level of the document testSelection(annotation, selectionBox, zoom, x, y) Determines if the provided point is a hit on the control handle. See Core.Annotations.SelectionAlgorithm for usuable selection algorithms. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation selectionBox Core.Math.Rect the selection rect zoom number the current zoom level of the document x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates Returns: true if the provided point is a hit Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.CustomAnnotation.html":{"id":"Core.Annotations.CustomAnnotation.html","title":"Class: CustomAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: CustomAnnotation Core.Annotations. CustomAnnotation new CustomAnnotation(type [, initializer]) The base class for custom annotations. Extending from this class will allow your annotation to appear the same in other viewers. This class will be serialized as a stamp and other viewers will view it as a stamp. However, this can be deserialized back into it's original type in WebViewer with the original behavior. Please store your custom attributes/values into the custom data using SerializedData so that it will be preserved. Parameters: Name Type Argument Description type object The initial element name for this custom annotation. initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Properties: Name Type Description SerializationTypes object An enumeration of custom annotation serialization method types. Properties Name Type Description STAMP string Saves custom annotation as a stamp. Compatible with other viewers. CUSTOM string Saves custom annotation using custom XFDF. Not compatible with other viewers. QualityScale number Gets/sets the quality of the annotation when saved as a stamp. The higher the value, the higher the quality and memory usage. Default: 2. SerializationType number Gets/sets the method this custom annotation class will be saved with. Default: STAMP. OutputImagePadding number Gets/sets the additional padding around the custom annotation stamp appearance. Extends Core.Annotations.MarkupAnnotation Members &lt;static&gt; OutputImagePadding The amount of additional padding applied to the image for drawing outside the annotation's rectangular bounds. Type: number &lt;static&gt; QualityScale The scaling factor that controls the output image quality. The higher the factor, the higher the quality, the higher the memory required. By default, this is set to two. Type: number &lt;static&gt; SerializationType The type of XFDF that will be produced when exported. The only acceptable values are 'custom' or 'stamp'. By default, 'stamp' is used. Type: string &lt;static&gt; SerializationTypes An enum with possible serialization types. If custom is used, the custom annotation will be serialized as is. Otherwise, stamp will be automatically assumed and the custom annotation will be serialized as a stamp. Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel SerializedData Gets an object that can be used to store primitive, custom data. Data set on this object will be saved to an annotations custom data automatically which gets preserved in the document. This property cannot be initialized through the initializer. Type: object StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods &lt;static&gt; createFromClass(type, annotClass) Converts an existing annotation class into a custom annotation that can be customized and viewed in other viewers. Parameters: Name Type Description type string The initial element name for this custom annotation. annotClass object The annotation class that will be made into a custom annotation instead. Returns: A custom annotation class that behaves the same as the input annotation class but is actually a custom annotation. Type object addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.DatePickerWidgetAnnotation.html":{"id":"Core.Annotations.DatePickerWidgetAnnotation.html","title":"Class: DatePickerWidgetAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: DatePickerWidgetAnnotation Core.Annotations. DatePickerWidgetAnnotation new DatePickerWidgetAnnotation(field, options) Represents a Date Picker Widget annotation. These include boxes and fields where date can be entered. Parameters: Name Type Argument Description field Core.Annotations.Forms.Field The field to associate with the widget options object &lt;nullable&gt; A map of properties to set on the widget Extends Core.Annotations.TextWidgetAnnotation Members &lt;static&gt; datePickerOptions Static property of DatePickerWidgetAnnotation for customizing DatePicker object DatePickerWidgetAnnotation.datePickerOptions Some of the options include: Type: object Example { \"isRTL\": true, // reverse the calendar for right-to-left languages \"firstDay\": 1, //first day of the week (0: Sunday, 1: Monday, etc) \"i18n\": { \"previousMonth\" : \"Previous Month\", \"nextMonth\" : \"Next Month\", \"months\" : [\"January\",\"February\",\"March\",\"April\",\"May\",\"June\",\"July\",\"August\",\"September\",\"October\",\"November\",\"December\"], \"monthsShort\" : [\"Jan\",\"Feb\",\"Mar\",\"Apr\",\"May\",\"Jun\",\"Jul\",\"Aug\",\"Sep\",\"Oct\",\"Nov\",\"Dec\"], \"weekdays\" : [\"Sunday\",\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\",\"Saturday\"], \"weekdaysShort\" : [\"Sun\",\"Mon\",\"Tue\",\"Wed\",\"Thu\",\"Fri\",\"Sat\"], \"invalidDateTime\": \"Custom error message\", }, // language defaults for month and weekday names \"yearRange\": [1900, 2015], // number of years either side (e.g. 10) or array of upper/lower range } Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect createInnerElement() Returns the HTML element of a widget annotation. Override this method to customize the HTML element. Inherited From: Core.Annotations.HTMLAnnotation#createInnerElement Returns: a HTML element Type HTMLElement deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getDatePicker() Returns DatePicker UI instance Returns: calendar UI instance getField() Gets the widget's associated field. Inherited From: Core.Annotations.WidgetAnnotation#getField Returns: The widget's field. Type Core.Annotations.Forms.Field getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getValue() Get the widget's value. Inherited From: Core.Annotations.WidgetAnnotation#getValue Returns: The widget's value (potentially formatted). Type string | number getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move refreshDatePicker() Refreshes DatePicker UI and update config from DatePickerWidgetAnnotation.datePickerOptions removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element set(options) Set all properties on this widget. Parameters: Name Type Description options Core.Annotations.WidgetAnnotation The set of parameters to set Inherited From: Core.Annotations.WidgetAnnotation#set setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setField(field) Sets the widget's associated field. Parameters: Name Type Description field Core.Annotations.Forms.Field The new field to associate with the widget. Inherited From: Core.Annotations.WidgetAnnotation#setField setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setValue(value) Set and format the widget's value. Parameters: Name Type Argument Description value string | number &lt;nullable&gt; The new value to set Inherited From: Core.Annotations.WidgetAnnotation#setValue setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.EllipseAnnotation.html":{"id":"Core.Annotations.EllipseAnnotation.html","title":"Class: EllipseAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: EllipseAnnotation Core.Annotations. EllipseAnnotation new EllipseAnnotation( [initializer]) Represents an ellipse annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.MarkupAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color Dashes Gets or sets the border dash style of an annotation. e.g '3' or '3,3' Type: string DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified DisplayFormat Gets or sets the annotation's measurement display format. Type: string Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementDisplayFormats = Annotations.Annotation.MeasurementDisplayFormats measurementAnnotation.DisplayFormat = measurementDisplayFormats.FRACTION }); DisplayUnits Gets or sets the annotation's measurement display units. Type: Array.&lt;string&gt; Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementUnits = Annotations.Annotation.MeasurementUnits measurementAnnotation.DisplayUnits = [measurementUnits.FT, measurementUnits.IN] }); elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Precision Gets or sets the annotation's precision from its measure dictionary. Type: number Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementDisplayFormats = Annotations.Annotation.MeasurementDisplayFormats measurementAnnotation.DisplayFormat = measurementDisplayFormats.FRACTION }); Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled Scale Gets or sets the annotation's scale from its measure dictionary. Type: Array.&lt;any&gt; selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Style Gets or sets the border style of an annotation. e.g Solid, Cloudy Type: string Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject System Gets or sets the annotation's system (Metric, Imperial, Typographic). Type: string Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementSystems = Annotations.Annotation.MeasurementSystems measurementAnnotation.System = measurementSystems.METRIC ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getMeasurementCaptionOptions() Gets the measurement annotation's caption options. Returns: The measurement caption options. Type Core.Annotations.measurementCaptionOptions getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setMeasurementCaptionOptions(options) Sets the measurement annotation's caption options. Parameters: Name Type Description options Core.Annotations.measurementCaptionOptions The measurement caption options. setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.FileAttachmentAnnotation.html":{"id":"Core.Annotations.FileAttachmentAnnotation.html","title":"Class: FileAttachmentAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: FileAttachmentAnnotation Core.Annotations. FileAttachmentAnnotation new FileAttachmentAnnotation( [initializer]) Represents a file attachment annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.MarkupAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Icon Gets or sets the icon for this fileattachment. Possible default icon types: Graph PushPin Paperclip Tag Type: string Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFileData() Gets the binary contents of the file attachment Returns: - A blob containing the binary contents of the file attachment Type Promise.&lt;Blob&gt; getFileMetadata() Returns: Object containing important attributes of the file Type Core.Annotations.FileAttachmentAnnotation.FileMetadata getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setFileData(data, mimeType, filename) Sets the binary contents of the file attachment Parameters: Name Type Description data ArrayBuffer An ArrayBuffer containing the binary contents of the fileattachment mimeType string The mimeType of the data, for example application/pdf filename string The filename for the attachment. This will be the name when the attachment is downloaded. Returns: A promise that resolves when the file data is set. Type Promise.&lt;void&gt; setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle Type Definitions FileMetadata Type: Object Properties: Name Type Description mimeType string The mimetype attribute of the file filename string The name of the file to be saved × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.Font.html":{"id":"Core.Annotations.Font.html","title":"Class: Font","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Font Core.Annotations. Font new Font( [params]) A class representing a PDF font. Parameters: Name Type Argument Description params object &lt;optional&gt; An object containing parameters to be initialised on the font. Properties: Name Type Argument Default Description name string The font's name size number &lt;optional&gt; 0 The font's size type string &lt;optional&gt; 'Type1' The font's type (One of CIDType0, CIDType2, MMType1, TrueType, Type0, Type1, Type3) strokeColor Core.Annotations.Color | array | object &lt;optional&gt; new Core.Annotations.Color([0,0,0]) The font's stroke color fillColor Core.Annotations.Color | array | object &lt;optional&gt; new Core.Annotations.Color([0,0,0]) The font's fill color calculatedSize number The calculated size of the font if size is 0 Methods isBlack() Is the font solid black? Returns: Whether the font is solid black Type boolean set(options) Set all properties on Font using a Font or a Font-like object. Parameters: Name Type Description options Core.Annotations.Font | object The options to set on the Font toCSS(zoom) Convert the font to a CSS object like one would pass to jQuery.css(). Parameters: Name Type Description zoom number Returns: An object appropriate to pass to jQuery.css() Type object × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.Forms.html":{"id":"Core.Annotations.Forms.html","title":"Class: Forms","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Forms Core.Annotations. Forms Contains the tools to create and manipulate form field data new Forms() Properties: Name Type Description getUsableInputWidth function A function to set the allowable width for fields with \"scroll long text\" disabled. It takes the width of the field and it should return a number which is the new allowable width Classes EmbeddedJS Field FieldManager × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.Forms.EmbeddedJS.html":{"id":"Core.Annotations.Forms.EmbeddedJS.html","title":"Class: EmbeddedJS","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: EmbeddedJS Core.Annotations.Forms. EmbeddedJS Contains functions for changing the default behavior of embedded PDF JavaScript new EmbeddedJS() Methods getFinalKeypressValue(globalEvent) Gets the keypress value of the active field after applying the latest keystroke Parameters: Name Type Description globalEvent object The global event object in the embedded JS context Returns: The current keypress value of the active field Type string update(callback) Hook into the existing embedded JS functions and update their implementations Parameters: Name Type Description callback function Function that is called with the embedded global object × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.Forms.Field.html":{"id":"Core.Annotations.Forms.Field.html","title":"Class: Field","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Field Core.Annotations.Forms. Field new Field(name [, options]) Represents a PDF Form field. Parameters: Name Type Argument Description name string The field's full name. options Core.Annotations.Forms.Field | object &lt;optional&gt; The options with which to construct the field. If options is a Field, the constructor returns the existing object. Properties Name Type Argument Description type string &lt;optional&gt; The field's type. One of ('Tx', 'Btn', 'Ch' or 'Sig'). value string &lt;optional&gt; The value of the field flags Core.Annotations.WidgetFlags &lt;optional&gt; The flags for the field children Array.&lt;Core.Annotations.Forms.Field&gt; &lt;optional&gt; The field's children. widgets Array.&lt;Core.Annotations.WidgetAnnotation&gt; &lt;optional&gt; The field's child widgets. fieldManager Core.Annotations.Forms.FieldManager &lt;optional&gt; The field's field manager. font Core.Annotations.Font &lt;optional&gt; The font that is used by the field. maxLen number &lt;optional&gt; The field's maximum length. -1 means infinite. tooltipName string &lt;optional&gt; The text to be displayed when hovering over the field. options Array.&lt;object&gt; &lt;optional&gt; The field's options (or permanently null if the field type does not support options). Properties: Name Type Argument Default Description type string Returns the field's type. One of ('Tx', 'Btn', 'Ch' or 'Sig') children Array.&lt;Core.Annotations.Forms.Field&gt; &lt;optional&gt; [] The field's children widgets Array.&lt;Core.Annotations.WidgetAnnotation&gt; &lt;optional&gt; [] The field's child widgets actions object.&lt;string, Array.&lt;Core.Actions.Action&gt;&gt; &lt;optional&gt; {} Gets the field's actions. defaultValue number | string &lt;optional&gt; null The field's default value exportValue number | string &lt;optional&gt; null The field's export value. Defaults to the field's value if not set. flags Core.Annotations.WidgetFlags &lt;optional&gt; new Core.Annotations.WidgetFlags() The field's flags object font Core.Annotations.Font &lt;optional&gt; new Core.Annotations.Font() Returns the field's associated font object IsModified boolean &lt;optional&gt; false Is field is modified? maxLen number &lt;optional&gt; -1 The field's maximum length. -1 means infinite. name string The full name of the field. options Array.&lt;object&gt; &lt;optional&gt; [] The field's options (or permanently null if the field type does not support options). quadding string &lt;optional&gt; 'Left-justified' Returns the field's quadding. (One of 'Left-justified', 'Right-justified', 'Centered') value number | string &lt;optional&gt; null The field's value. tooltipName string The text to be displayed when hovering over the field. Mixes In: Core.Actions.Dispatcher Listens to Events: Core.Annotations.Forms.Field#event:calculate Core.Annotations.Forms.Field#event:commit Methods commit(event, value [, widget]) Commits the new value to the field (triggers Validate action, and updates all widgets) Parameters: Name Type Argument Description event * Ignored. value string | number &lt;nullable&gt; The new value. widget Core.Annotations.WidgetAnnotation &lt;optional&gt; Optionally a particular widget annotation associated with the field getFieldType() Returns the field's type Returns: The field type as defined by the FormFieldTypes enum Type string getValue() Gets the field's value Returns: The value of the field Type string | number hide() Disable visibility of all child widgets isTerminal() Checks whether the current field is a terminal/leaf node (no children). Returns: Whether this field is terminal/leaf node Type boolean refreshAppearances() Refresh the appearance of each widget in the current field. set(options) Set all field properties form the given object. Parameters: Name Type Description options Core.Annotations.Forms.Field | object The object to set properties from. setType(type) Sets the field's type. Tries to retain as much type-specific information as possible across type changes. Parameters: Name Type Description type string The new field type, one of Tx, Ch, Btn or Sig. setValue(value [, widget]) Sets the field's value, following any type-specific constraints, and updating all widgets. Parameters: Name Type Argument Description value string | number &lt;nullable&gt; The value to set. widget Core.Annotations.WidgetAnnotation &lt;optional&gt; Optionally a particular widget annotation associated with the field Fires: Core.Annotations.Forms.Field#event:change setVisible(visible) Sets the visibility of all child widgets Parameters: Name Type Description visible boolean Should the field be visible? Deprecated: since version 8.0 Please use show or hide instead show() Enable visibility of all child widgets Events calculate A signal that the field should fire its own calculation events. Parameters: Name Type Description source Core.Annotations.Forms.Field The field that caused the calculation event. Listeners of This Event: Core.Annotations.Forms.Field change An event that represents a field's value having changed. Parameters: Name Type Description field Core.Annotations.Forms.Field The field that has changed. commit The field's value has been changed by the user. Sets a new value. Parameters: Name Type Argument Description value string | number &lt;nullable&gt; The new field value. Listeners of This Event: Core.Annotations.Forms.Field × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.Forms.FieldManager.html":{"id":"Core.Annotations.Forms.FieldManager.html","title":"Class: FieldManager","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: FieldManager Core.Annotations.Forms. FieldManager new FieldManager(annotationManager) Represents a tree of PDF Forms fields. @see Core.Annotations.Forms.Field Allows adding, getting and visiting fields. Parameters: Name Type Description annotationManager Core.AnnotationManager Methods addField(field [, update]) Adds the given field object to the field tree, either replacing or merging with any existing field. Note: if the field is merged, it is the equivalent of performing Annotations.Forms.Field.set on the existing field, followed by setting all the field's widgets' fields to the original field. Parameters: Name Type Argument Default Description field Core.Annotations.Forms.Field | object The field or field-like object to add. update boolean &lt;optional&gt; false Returns: The field that was inserted into the field tree (may not be the field originally provided). Type Core.Annotations.Forms.Field areRequiredFieldsFilled() iterate over every field and check if it's required and if it has a value Returns: Returns True if there is no required field or all fields are filled out, false otherwise Type boolean calculate(field [, index]) Equivalent to the given field's value changing, if it was at position index in the calculation order. Parameters: Name Type Argument Default Description field Core.Annotations.Forms.Field &lt;nullable&gt; The field to set as source for the calculation event. May be null. index number &lt;optional&gt; 0 The index at which to start running the calculation order. fieldChanged(field) Listener for field value changes. Parameters: Name Type Description field Core.Annotations.Forms.Field The field whose value changed. forEachField(callback) Calls the specified callback for each of the root fields in the document. If there is a tree of form fields, then this will only iterate over root fields. Please use Core.Annotations.Forms.Field.children and a tree traversal algorithm to traverse the fields. If you know the name of your field, you can use Core.Annotations.Forms.FieldManager.getField. Parameters: Name Type Description callback function The function that will be called for each field. The callback is passed the field object. Example const stack = []; fieldManager.forEachField(function(field) { stack.push(field); // Push root fields }); while (stack.length &gt; 0) { const current = stack.pop(); if (current.isTerminal()) { // Work with terminal/leaf fields } else { // Traverse children stack = stack.concat(current.children); } } getField(name) Gets a field whose full name matches the one that is given. If No field matches, and the last part of the field name is a number, returns that index of the field's widget array. Parameters: Name Type Description name string The full name of the field to search for. Returns: The field or widget, or null if no field matches. Type Core.Annotations.Forms.Field | Core.Annotations.WidgetAnnotation getFields() Returns an array of all field objects in the document Returns: Type Array.&lt;Core.Annotations.Forms.Field&gt; print() Invokes the available print handler to print the document Note: This method requires Embedded JavaScript to not have been disabled with Core.disableEmbeddedJavaScript setAlertHandler(handler) Updates the function to be used for handling alert messages for field validation. Parameters: Name Type Description handler function The function that will handle alert messages. It will be called with a string representing the alert message. setCalculationOrder(order) Set the calculation order - use this if you need changes in one field to trigger calculation events on other fields. If the name of field that is changed is before the name of another field, that other field is recalculated. If the name of the field that has changed is not in the array, all the fields named by the arrya are recalculated in order. Parameters: Name Type Description order Array.&lt;string&gt; An array of field names. setPrintHandler() Sets the function to be used to handle the print API called by embedded PDF JavaScript updateFieldName(field, name) Renames the field that is passed to the name passed in. Parameters: Name Type Description field Core.Annotations.Forms.Field | object The field that should be renamed. name string The name of the field to be renamed. Cannot be blank. Returns: The renamed field. Type Core.Annotations.Forms.Field | Core.Annotations.WidgetAnnotation × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.FreeHandAnnotation.html":{"id":"Core.Annotations.FreeHandAnnotation.html","title":"Class: FreeHandAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: FreeHandAnnotation Core.Annotations. FreeHandAnnotation new FreeHandAnnotation( [initializer]) Represents a FreeHand annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.IPathAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author BottomMost The bottommost point of the annotation. This property cannot be initialized through the initializer. Type: number Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Intent Gets or sets the intent of the freehand. Type: string Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified LeftMost The leftmost point of the annotation. This property cannot be initialized through the initializer. Type: number Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType RightMost The rightmost point of the annotation. This property cannot be initialized through the initializer. Type: number Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel shouldSimplifyPath Whether to simplify the path points or not. Type: boolean Default Value: false StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName TopMost The topmost point of the annotation. This property cannot be initialized through the initializer. Type: number ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance addPathPoint(x, y [, pathIndex]) Adds a point to the specified path. This method will create a new path if the specified path index is equal to the total number of existings paths, and set the x and y value as its first point. Parameters: Name Type Argument Description x number The x coordinate of the point y number The y coordinate of the point pathIndex number &lt;optional&gt; The index of the path, defaults to 0 Overrides: Core.Annotations.IPathAnnotation#addPathPoint adjustRect() Recalculate the width and height of the annotation Inherited From: Core.Annotations.IPathAnnotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw emptyPaths() empty the paths in the path array. enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getPath( [pathIndex]) Gets the specified path in the path array. Parameters: Name Type Argument Description pathIndex number &lt;optional&gt; The index of the path, defaults to 0 Overrides: Core.Annotations.IPathAnnotation#getPath Returns: The array of path points Type Array.&lt;Core.Math.Point&gt; getPathPoint(index [, pathIndex]) Gets the specified point in the path at the specified index. Parameters: Name Type Argument Description index number The index of the point in the specified path pathIndex number &lt;optional&gt; The index of the path, defaults to 0 Overrides: Core.Annotations.IPathAnnotation#getPathPoint Returns: The path point as an object with x and y properties Type Core.Math.Point getPaths() Gets the array of paths for this annotation. Returns: an array of paths, where a path is an array of Annotation.Points Type Array getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move popPath( [pathIndex]) Removes the last point from the specified path. Parameters: Name Type Argument Description pathIndex number &lt;optional&gt; The index of the path, defaults to 0 Overrides: Core.Annotations.IPathAnnotation#popPath Returns: The point that was removed from the path. Type Core.Math.Point removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; rotate(angle, rotationPoint) Rotate the annotation by angle and origin point to rotate around. Parameters: Name Type Description angle number The angle in radians rotationPoint Core.Math.Point The rotation point to do the rotation around. The default is the center point of the annotation Inherited From: Core.Annotations.IPathAnnotation#rotate serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setPath(path, pathIndex) Sets a path in the path array. Parameters: Name Type Description path Array.&lt;Core.Math.Point&gt; An array of Annotation.Point objects. pathIndex number The index of the path, defaults to 0 setPathPoint(index, x, y [, pathIndex]) Sets a point at the specified path. This method will create a new path if the specified path index is equal to the total number of existings paths, and set the x and y value as its first point. Parameters: Name Type Argument Description index number The index in the path array to set x number The x coordinate of the point y number The y coordinate of the point pathIndex number &lt;optional&gt; The index of the path, defaults to 0 Overrides: Core.Annotations.IPathAnnotation#setPathPoint setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:42-07:00 using the DocStrap template. "},"Core.Annotations.FreeTextAnnotation.html":{"id":"Core.Annotations.FreeTextAnnotation.html","title":"Class: FreeTextAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: FreeTextAnnotation Core.Annotations. FreeTextAnnotation new FreeTextAnnotation( [intent] [, initializer]) Represents a free text annotation. Parameters: Name Type Argument Description intent string &lt;optional&gt; The intended usage type of this freetext annotation. Could either be freetext or callout. initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Properties: Name Type Description EXPORT_CALCULATED_FONT_SIZE boolean Whether to export calculated font size for auto-sized fonts. Default: true Intent object An enumeration of possible intents for FreeText Annotations Properties Name Type Description FreeText string Should treat as regular freetext FreeTextCallout string Should treat as callout Extends Core.Annotations.IPathAnnotation Classes RichTextEditor Members &lt;static&gt; AutoSizeTypes An enum with possible auto-size types. Properties: Name Type Description NONE string Freetext stays at fixed size AUTO string Autosize to content FIXED_WIDTH string Width cannot be changed FIXED_HEIGHT string Height cannot be changed &lt;static&gt; Intent An enum with possible freetext intents. Properties: Name Type Description FreeText string Treat as regular freetext FreeTextCallout string Treat as callout Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author autoSizeProperties Object that contains all the flags to customize the auto-sizing behavior Type: object Properties: Name Type Description shrinkWidth boolean Whether to shrink the width of the annotation if the size of its contents are smaller in width than the annotation shrinkHeight boolean Whether to shrink the height of the annotation if the size of its contents are smaller in height than the annotation expandWidth boolean Whether to expand the width of the annotation if the size of the contents are larger in width than the annotation expandHeight boolean Whether to expand the height of the annotation if the size of the contents are larger in height than the annotation Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Font The font to use for the annotation's text. Type: string FontSize The font size to use for the annotation's text, specified like a CSS font size. Type: string Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject TextAlign The horizontal alignment of the annotation's text (left, right, center) Type: string TextColor The color of the text in the annotation. Type: Core.Annotations.Color TextVerticalAlign The vertical alignment of the annotation's text (top, bottom, center) default: top Type: string ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance addPathPoint(x, y) Adds a point to the path Parameters: Name Type Description x number The x coordinate of the point y number The y coordinate of the point Inherited From: Core.Annotations.IPathAnnotation#addPathPoint adjustRect() Recalculate the width and height of the annotation Inherited From: Core.Annotations.IPathAnnotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableEnterKeypress() Disables the Enter key for the instance of RichTextEditor disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableEnterKeypress() Enables the Enter key for the instance of RichTextEditor enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl fitText(pageInfo, pageMatrix, pageRotation) Resize the annotation's text box to fit its contents Parameters: Name Type Description pageInfo Core.Document.PageInfo An object representing the page info. Contains the properties \"width\" and \"height\". pageMatrix object The transformation matrix for the page that the annotation is on. pageRotation number The internal degrees of rotation of the current page. Example const freetextAnnot = annotManager.getAnnotationsList()[0]; const doc = docViewer.getDocument(); const pageNumber = 1; const pageInfo = doc.getPageInfo(pageNumber); const pageMatrix = doc.getPageMatrix(pageNumber); const pageRotation = doc.getPageRotation(pageNumber); freetextAnnot.fitText(pageInfo, pageMatrix, pageRotation); annotManager.drawAnnotationsFromList([freetextAnnot]); getAutoSizeType() Gets the auto-sizing method if any. Returns: The type of autosizing method Type string getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getDateFormat() Gets the date format of the FreeText (if any) Returns: Returns Date format Type string getEditor() Returns: Returns the rich text editor instance associated with the annotation Type Core.Annotations.FreeTextAnnotation.RichTextEditor getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getIntent() Gets the intent of the FreeText annotation e.g. FreeTextCallout Returns: The intent of the annotation Type string getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPadding() Get the rectangle difference of the annotation bounding rect and the text rect Returns: the rectangle difference Type Core.Math.Rect getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getPath() Gets the path array Inherited From: Core.Annotations.IPathAnnotation#getPath Returns: The array of path points Type Array.&lt;Core.Math.Point&gt; getPathPoint(index) Gets the point in the path at the specified index Parameters: Name Type Description index number The index in the path array Inherited From: Core.Annotations.IPathAnnotation#getPathPoint Returns: The path point as an object with x and y properties Type object getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStartStyle() Gets the start style of the line. Only applicable for callout annotations Returns: The start style Type string getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isAutoSized() Returns: Returns a boolean which indicates if the bounding box of the freetext will be resized automatically when its contents are being edited Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move popPath() Removes the last point from the path Inherited From: Core.Annotations.IPathAnnotation#popPath Returns: The path point as an object with x and y properties Type object removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; rotate(angle, rotationPoint) Rotate the annotation by angle and origin point to rotate around. Parameters: Name Type Description angle number The angle in radians rotationPoint Core.Math.Point The rotation point to do the rotation around. The default is the center point of the annotation Inherited From: Core.Annotations.IPathAnnotation#rotate serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setAutoSizeType(type) Sets how the freetext annotation auto-sizes to content. Parameters: Name Type Description type string Use one of the types provided by AutoSizeTypes setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setDateFormat(format) Set FreeText as a date type annotation with the specified format. A viewer can use this information to allow easier updating of the text to represent a date, for example by using a date picker. Parameters: Name Type Description format string Set Annotation Date format setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setIntent(intent) Sets the intent of the FreeText annotation Parameters: Name Type Description intent string The new intent for the annotation setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPadding(rect) Sets the rectangle difference of the annotation bounding rect and the text rect Parameters: Name Type Description rect Core.Math.Rect The new rectangle difference setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setPathPoint(index, x, y) Sets the path point at a specific index Parameters: Name Type Description index number The index in the path array to set x number The x coordinate of the point y number The y coordinate of the point Inherited From: Core.Annotations.IPathAnnotation#setPathPoint setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStartStyle(startStyle) Sets the start style of the line. Only applicable for callout annotations. Parameters: Name Type Description startStyle string The starting style setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:43-07:00 using the DocStrap template. "},"Core.Annotations.FreeTextAnnotation.RichTextEditor.html":{"id":"Core.Annotations.FreeTextAnnotation.RichTextEditor.html","title":"Class: RichTextEditor","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: RichTextEditor Core.Annotations.FreeTextAnnotation. RichTextEditor A class that represents controls used for editing contents of a freetext annotation new RichTextEditor() Methods &lt;static&gt; getEditorOptions() Gets the Quill editor options. Returns: Quill options that are currently set. Type Core.Annotations.FreeTextAnnotation.RichTextEditor.QuillEditorOptions &lt;static&gt; setEditorOptions(options) Sets the Quill editor options. Parameters: Name Type Description options Core.Annotations.FreeTextAnnotation.RichTextEditor.QuillEditorOptions Quill options to be set. deleteText(index, length) Delete some content from the editor. Parameters: Name Type Description index number the start index of the range length number the length of the range format(format, value) Format text at the current selection. If the current selection has length of 0, then the format will be set active. Parameters: Name Type Description format Core.Annotations.FreeTextAnnotation.RichTextEditor.Format value Core.Annotations.FreeTextAnnotation.RichTextEditor.FormatValue getContents() Gets the current contents in the editor Returns: Returns the current contents in the editor Type string getFormat(index, length) Gets the format of the text in the given range. Parameters: Name Type Description index number the start index of the range length number the length of the range Returns: Returns the format of the given range Type object getSelection() Gets the current selection range in the editor. Returns: Returns the current selection range Type Core.EditBoxManager.Range hasFocus() Checks if the editor is being focused. Returns: Whether the editor is focused Type boolean insertText(index, contents) Insert the content in the editor. Parameters: Name Type Description index number the start index of the range contents string the contents that need to be updated in the editor setSelection(index, length) Sets the current selection in the editor. Parameters: Name Type Description index number the start index of the range length number the length of the selection range setText(contents) Sets the content in the editor. Parameters: Name Type Description contents string the contents that need to be updated in the editor Type Definitions Format The available formats of an editor instance Type: 'color' | 'bold' | 'italic' | 'underline' | 'strike' FormatValue The value of a format. The value should be a hex color string(e.g. #FF00FF) for the `color` format, and boolean for the rest of formats. Type: string | boolean QuillEditorOptions Properties: Name Type Description bounds Element DOM Element or a CSS selector for a DOM Element, within which the editor’s UI elements (i.e. tooltips, etc.) should be confined. Currently, it only considers left and right boundaries. debug string Shortcut for debug. Note debug is a static method and will affect other instances of Quill editors on the page. Only warning and error messages are enabled by default. formats object [WARNING: this is not fully supported by WebViewer and may result in unexpected behavior] Whitelist of formats to allow in the editor. See Formats for a complete list. modules object Collection of modules to include and respective options. See Modules for more information. placeholder string Placeholder text to show when editor is empty. readOnly boolean Whether to instantiate the editor in read-only mode. scrollingContainer Element DOM Element or a CSS selector for a DOM Element, specifying which container has the scrollbars (i.e. overflow-y: auto), if is has been changed from the default ql-editor with custom CSS. Necessary to fix scroll jumping bugs when Quill is set to auto grow its height, and another ancestor container is responsible from the scrolling. theme string [WARNING: this is not fully supported by WebViewer and may result in unexpected behavior] Themes to use for the editor. × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:43-07:00 using the DocStrap template. "},"Core.Annotations.FreeTextSelectionModel.html":{"id":"Core.Annotations.FreeTextSelectionModel.html","title":"Class: FreeTextSelectionModel","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: FreeTextSelectionModel Core.Annotations. FreeTextSelectionModel A selection model based on the annotation's bounding box. This is used for free text annotations. new FreeTextSelectionModel(annotation, canModify, isSelected) Creates a free text selection model. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation canModify boolean indicates if the annotation can be modified isSelected boolean Extends Core.Annotations.BoxSelectionModel Methods canModify() Indicates that the associated annotation is able to be modified Inherited From: Core.Annotations.SelectionModel#canModify Returns: Type boolean drawSelectionOutline(ctx, annotation, zoom) Draws the selection outline of the annotation. By default, a rectangle is drawn based on the annotations x, y, width and height. Parameters: Name Type Description ctx CanvasRenderingContext2D annotation Core.Annotations.Annotation zoom number Inherited From: Core.Annotations.SelectionModel#drawSelectionOutline getControlHandles() Returns the ControlHandle objects associated with this selection model. Inherited From: Core.Annotations.SelectionModel#getControlHandles Returns: An array of ControlHandleObject Type Array.&lt;Core.Annotations.ControlHandle&gt; getDimensions(annotation) Gets the dimensions {x, y, width, height} of the selection bounding box. It may be different from the annotation's bounding box. e.g. The selection bounding box may have a padding. Parameters: Name Type Description annotation Core.Annotations.Annotation Inherited From: Core.Annotations.SelectionModel#getDimensions Returns: Type Core.Math.Rect isSelected() Indicates that the associated annotation is already selected. This can be useful to implement different selection behaviors when an annotation is selected. Inherited From: Core.Annotations.SelectionModel#isSelected Returns: Type boolean testControlHandles(annotation, zoom, x, y) Hit detection for each control handle. Parameters: Name Type Description annotation Core.Annotations.Annotation zoom number x number y number Inherited From: Core.Annotations.SelectionModel#testControlHandles Returns: The control handle that was hit Type Core.Annotations.ControlHandle testSelection(annotation, x, y, pageMatrix, zoom, rotation) Determines if the provided point is a hit on the selected annotationhandle. * See Core.Annotations.SelectionAlgorithm for usuable selection algorithms. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates pageMatrix object the page matrix of the page the annotation is on zoom number the zoom level of the page the annotation is on rotation Core.PageRotation the rotation of the page the annotation is on Inherited From: Core.Annotations.SelectionModel#testSelection Returns: true if the provided point is a hit Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:43-07:00 using the DocStrap template. "},"Core.Annotations.HTMLAnnotation.html":{"id":"Core.Annotations.HTMLAnnotation.html","title":"Class: HTMLAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: HTMLAnnotation Core.Annotations. HTMLAnnotation new HTMLAnnotation() An common base class annotation that displays its contents using HTML5 instead of via Canvas. Properties: Name Type Argument Default Description rect Object The annotation's rectangle element Element &lt;nullable&gt; Gets the annotation's outer display element, if it exists innerElement Element &lt;nullable&gt; Gets the annotation's inner UI element, if it exists hidden boolean &lt;optional&gt; false Gets and sets whether the annotation is hidden color Core.Annotations.Color | object | Array.&lt;any&gt; &lt;optional&gt; new Core.Annotations.Color() Gets and sets the annotation's color (any type that can be used to construct Core.Annotations.Color) border Core.Annotations.Border | object &lt;optional&gt; new Core.Annotations.Border() Gets and sets the annotation's border (is a border, or a map of border properties) backgroundColor Core.Annotations.Color | object | Array.&lt;any&gt; &lt;optional&gt; new Core.Annotations.Color() Gets and sets the annotation's background color actions Object &lt;optional&gt; {} Gets the actions attached to this annotation as an object with triggers as keys and arrays of actions as values rotation number &lt;optional&gt; 0 Gets and sets the annotation's rotation (must be one of 0, 90, 180, 270) Mixes In: Core.Actions.Dispatcher Extends Core.Annotations.Annotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect createInnerElement() Returns the HTML element of a widget annotation. Override this method to customize the HTML element. Returns: a HTML element Type HTMLElement deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:43-07:00 using the DocStrap template. "},"Core.Annotations.IPathAnnotation.html":{"id":"Core.Annotations.IPathAnnotation.html","title":"Class: IPathAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: IPathAnnotation Core.Annotations. IPathAnnotation new IPathAnnotation( [initializer]) An abstract annotation class for aiding the creation of path-based annotations. Classes extending IPathAnnotation or implements the interface can be used by the PathTools. Note: this class makes no assumptions on serialization Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.MarkupAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance addPathPoint(x, y) Adds a point to the path Parameters: Name Type Description x number The x coordinate of the point y number The y coordinate of the point adjustRect() Recalculate the width and height of the annotation Overrides: Core.Annotations.MarkupAnnotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getPath() Gets the path array Returns: The array of path points Type Array.&lt;Core.Math.Point&gt; getPathPoint(index) Gets the point in the path at the specified index Parameters: Name Type Description index number The index in the path array Returns: The path point as an object with x and y properties Type object getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move popPath() Removes the last point from the path Returns: The path point as an object with x and y properties Type object removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; rotate(angle, rotationPoint) Rotate the annotation by angle and origin point to rotate around. Parameters: Name Type Description angle number The angle in radians rotationPoint Core.Math.Point The rotation point to do the rotation around. The default is the center point of the annotation serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setPathPoint(index, x, y) Sets the path point at a specific index Parameters: Name Type Description index number The index in the path array to set x number The x coordinate of the point y number The y coordinate of the point setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:43-07:00 using the DocStrap template. "},"Core.Annotations.LineAnnotation.html":{"id":"Core.Annotations.LineAnnotation.html","title":"Class: LineAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: LineAnnotation Core.Annotations. LineAnnotation new LineAnnotation( [initializer]) Represents a line annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.MarkupAnnotation Members &lt;static&gt; CaptionSnapPositions Type: string Properties: Name Type Description START string Indicates the caption is snapped to start point of measurement annotation. CENTER string Indicates the caption is snapped to center point of measurement annotation. END string Indicates the caption is snapped to end point of measurement annotation. Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color Dashes Gets or sets the border dash style of an annotation. e.g '3' or '3,3' Type: string DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified DisplayFormat Gets or sets the annotation's measurement display format. Type: string Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementDisplayFormats = Annotations.Annotation.MeasurementDisplayFormats measurementAnnotation.DisplayFormat = measurementDisplayFormats.FRACTION }); DisplayUnits Gets or sets the annotation's measurement display units. Type: Array.&lt;string&gt; Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementUnits = Annotations.Annotation.MeasurementUnits measurementAnnotation.DisplayUnits = [measurementUnits.FT, measurementUnits.IN] }); elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName End Gets or sets the end point of the line. Type: Core.Math.Point FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Precision Gets or sets the annotation's precision from its measure dictionary. Type: number Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementDisplayFormats = Annotations.Annotation.MeasurementDisplayFormats measurementAnnotation.DisplayFormat = measurementDisplayFormats.FRACTION }); Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled Scale Gets or sets the annotation's scale from its measure dictionary. Type: Array.&lt;any&gt; selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel Start Gets or sets the start point of the line. Type: Core.Math.Point StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Style Gets or sets the border style of an annotation. e.g Solid, Cloudy Type: string Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject System Gets or sets the annotation's system (Metric, Imperial, Typographic). Type: string Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementSystems = Annotations.Annotation.MeasurementSystems measurementAnnotation.System = measurementSystems.METRIC ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getAngle() Returns the angle in radians from the X axis from start point to end point Returns: The angle in radians Type number getCaptionSnapPosition() Get the current caption snap position. See: CaptionSnapPositions Returns: Returns the current caption snap position. Type Core.Annotations.LineAnnotation.CaptionSnapPositions getCenterLeaderPoint() Returns the leader point located at the center (midpoint) of measurement line. Deprecated: Since version 8.5. Use getLeaderLineControlHandlePoint instead. Returns: Center (midpoint) of measurement line. Type Core.Math.Point getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getEndPoint() Gets the ending point of the line Returns: The end point Type Core.Math.Point getEndStyle() Gets the end style of the line Returns: The end style Type Core.Annotations.LineEndType getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getLeaderLineControlHandlePoint( [captionSnapPosition]) Returns the leader point located at the given caption snap position, in viewer coordinates. Parameters: Name Type Argument Description captionSnapPosition Core.Annotations.LineAnnotation.CaptionSnapPositions &lt;optional&gt; Indicates which side of measurement line to calculate leader point. Default value is whatever is returned from Core.Annotations.LineAnnotation#getCaptionSnapPosition. Returns: Position of leader control handle, in viewer coordinates. Type Core.Math.Point getLeaderPoints() Returns the leader points of this line Returns: An object containing the two leader points Type Core.Annotations.LineAnnotation.LeaderPoints getLineLength() Returns the length of the line in points Returns: The length in points Type number getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStartPoint() Gets the starting point of the line Returns: The start point Type Core.Math.Point getStartStyle() Gets the start style of the line Returns: The start style Type Core.Annotations.LineEndType getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setCaptionSnapPosition(position) Snaps the caption of a measurement line to given position. Parameters: Name Type Description position Core.Annotations.LineAnnotation.CaptionSnapPositions Use one of the positions provided by CaptionSnapPositions setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setEndPoint(x, y) Sets the ending point of the line Parameters: Name Type Description x number The x coordinate of the point y number The y coordinate of the point setEndStyle(endingStyle) Sets the ending style of the line Parameters: Name Type Description endingStyle Core.Annotations.LineEndType The ending style setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setLineLength(length) Sets the length of a line Parameters: Name Type Description length number The length in points setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStartPoint(x, y) Sets the starting point of the line Parameters: Name Type Description x number The x coordinate of the point y number The y coordinate of the point setStartStyle(startStyle) Sets the start style of the line Parameters: Name Type Description startStyle Core.Annotations.LineEndType The starting style setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle Type Definitions LeaderPoints the point in viewer coordinates Type: Object Properties: Name Type Description Start Core.Math.Point the start point End Core.Math.Point the end point × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:43-07:00 using the DocStrap template. "},"Core.Annotations.LineControlHandle.html":{"id":"Core.Annotations.LineControlHandle.html","title":"Class: LineControlHandle","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: LineControlHandle Core.Annotations. LineControlHandle A control handle for the Core.Annotations.LineAnnotation. new LineControlHandle(x, y, width, height, isEnd) Creates a line control handle. Parameters: Name Type Description x number the x coordinate of the point y number the y coordinate of the point width number the width of the handle height number the height of the handle isEnd boolean true if the handle is for the start point, false if the handle is for the end point Extends Core.Annotations.ControlHandle Methods draw(ctx, annotation, selectionBox, zoom) Draws the control handle's appearance on the provided canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D the annotation canvas context annotation Core.Annotations.Annotation the annotation to modify selectionBox Core.Math.Rect the selection rect zoom number the current zoom level of the document Inherited From: Core.Annotations.ControlHandle#draw testSelection(annotation, selectionBox, zoom, x, y) Determines if the provided point is a hit on the control handle. See Core.Annotations.SelectionAlgorithm for usuable selection algorithms. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation selectionBox Core.Math.Rect the selection rect zoom number the current zoom level of the document x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates Inherited From: Core.Annotations.ControlHandle#testSelection Returns: true if the provided point is a hit Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:43-07:00 using the DocStrap template. "},"Core.Annotations.LineSelectionModel.html":{"id":"Core.Annotations.LineSelectionModel.html","title":"Class: LineSelectionModel","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: LineSelectionModel Core.Annotations. LineSelectionModel A selection model for LineAnnotation. new LineSelectionModel(annotation, canModify) Creates a line selection model. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation canModify boolean indicates if the annotation can be modified Extends Core.Annotations.SelectionModel Methods canModify() Indicates that the associated annotation is able to be modified Inherited From: Core.Annotations.SelectionModel#canModify Returns: Type boolean drawSelectionOutline(ctx, annotation, zoom) Draws the selection outline of the annotation. By default, a rectangle is drawn based on the annotations x, y, width and height. Parameters: Name Type Description ctx CanvasRenderingContext2D annotation Core.Annotations.Annotation zoom number Inherited From: Core.Annotations.SelectionModel#drawSelectionOutline getControlHandles() Returns the ControlHandle objects associated with this selection model. Inherited From: Core.Annotations.SelectionModel#getControlHandles Returns: An array of ControlHandleObject Type Array.&lt;Core.Annotations.ControlHandle&gt; getDimensions(annotation) Gets the dimensions {x, y, width, height} of the selection bounding box. It may be different from the annotation's bounding box. e.g. The selection bounding box may have a padding. Parameters: Name Type Description annotation Core.Annotations.Annotation Inherited From: Core.Annotations.SelectionModel#getDimensions Returns: Type Core.Math.Rect isSelected() Indicates that the associated annotation is already selected. This can be useful to implement different selection behaviors when an annotation is selected. Inherited From: Core.Annotations.SelectionModel#isSelected Overrides: Core.Annotations.SelectionModel#isSelected Returns: Type boolean testControlHandles(annotation, zoom, x, y) Hit detection for each control handle. Parameters: Name Type Description annotation Core.Annotations.Annotation zoom number x number y number Inherited From: Core.Annotations.SelectionModel#testControlHandles Returns: The control handle that was hit Type Core.Annotations.ControlHandle testSelection(annotation, x, y, pageMatrix, zoom, rotation) Determines if the provided point is a hit on the selected annotationhandle. * See Core.Annotations.SelectionAlgorithm for usuable selection algorithms. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates pageMatrix object the page matrix of the page the annotation is on zoom number the zoom level of the page the annotation is on rotation Core.PageRotation the rotation of the page the annotation is on Inherited From: Core.Annotations.SelectionModel#testSelection Returns: true if the provided point is a hit Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:43-07:00 using the DocStrap template. "},"Core.Annotations.Link.html":{"id":"Core.Annotations.Link.html","title":"Class: Link","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Link Core.Annotations. Link new Link(options) Represents a PDF Link annotation with associated actions. Parameters: Name Type Description options object A map of properties to set on the new Link Extends Core.Annotations.HTMLAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect createInnerElement() Returns the HTML element of a widget annotation. Override this method to customize the HTML element. Inherited From: Core.Annotations.HTMLAnnotation#createInnerElement Returns: a HTML element Type HTMLElement deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isAutomaticLink() Returns whether the link is added by WebViewer automatically. Returns: Whether the link is added by WebViewer automatically. Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:43-07:00 using the DocStrap template. "},"Core.Annotations.ListWidgetAnnotation.html":{"id":"Core.Annotations.ListWidgetAnnotation.html","title":"Class: ListWidgetAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: ListWidgetAnnotation Core.Annotations. ListWidgetAnnotation Represents a List Widget annotation (a list). new ListWidgetAnnotation(field, options) Creates a new instance of ListWidgetAnnotation. Parameters: Name Type Argument Description field Core.Annotations.Forms.Field The field to associate with the widget options object &lt;nullable&gt; A map of properties to set on the widget Extends Core.Annotations.WidgetAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect createInnerElement() Returns the HTML element of a widget annotation. Override this method to customize the HTML element. Inherited From: Core.Annotations.HTMLAnnotation#createInnerElement Returns: a HTML element Type HTMLElement deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getField() Gets the widget's associated field. Inherited From: Core.Annotations.WidgetAnnotation#getField Returns: The widget's field. Type Core.Annotations.Forms.Field getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getValue() Get the widget's value. Inherited From: Core.Annotations.WidgetAnnotation#getValue Returns: The widget's value (potentially formatted). Type string | number getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element set(options) Set all properties on this widget. Parameters: Name Type Description options Core.Annotations.WidgetAnnotation The set of parameters to set Inherited From: Core.Annotations.WidgetAnnotation#set setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setField(field) Sets the widget's associated field. Parameters: Name Type Description field Core.Annotations.Forms.Field The new field to associate with the widget. Inherited From: Core.Annotations.WidgetAnnotation#setField setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setValue(value) Set and format the widget's value. Parameters: Name Type Argument Description value string | number &lt;nullable&gt; The new value to set Inherited From: Core.Annotations.WidgetAnnotation#setValue setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:43-07:00 using the DocStrap template. "},"Core.Annotations.MarkupAnnotation.html":{"id":"Core.Annotations.MarkupAnnotation.html","title":"Class: MarkupAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: MarkupAnnotation Core.Annotations. MarkupAnnotation Represents an extendable Markup annotation. These annotations may optionally include a fill color, stroke color, and stroke thickness. new MarkupAnnotation( [initializer]) Creates a new instance of MarkupAnnotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.Annotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:43-07:00 using the DocStrap template. "},"Core.Annotations.Model3D.html":{"id":"Core.Annotations.Model3D.html","title":"Class: Model3D","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Model3D Core.Annotations. Model3D new Model3D(options) Represents a 3D annotation. Parameters: Name Type Description options object A map of properties to set on the 3D annotation Extends Core.Annotations.HTMLAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect createInnerElement() Returns the HTML element of a widget annotation. Override this method to customize the HTML element. Inherited From: Core.Annotations.HTMLAnnotation#createInnerElement Returns: a HTML element Type HTMLElement deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableCameraControls() Disable camera controls for the 3D model Once disabled the 3D model is moveable on the page but able to be rotated or zoomed disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableCameraControls() Enable camera controls for the 3D model Once enabled the 3D model is able to be rotated and zoomed but not able to be dragged around the page Note that if the model is not interactive then camera controls cannot be enabled. enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl get3DData() Returns: The 3D model data as a base64 string Type string getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInteractive() Returns: Whether the 3D object is interactive (can rotate and zoom) Type boolean getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element set3DData(base64) Sets the 3D data for the annotation. Parameters: Name Type Description base64 string the 3d data in base64 format setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setInteractive(interactive) Sets whether the 3D object is interactive Parameters: Name Type Description interactive boolean boolean to denote if the model is interactive setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:43-07:00 using the DocStrap template. "},"Core.Annotations.PathControlHandle.html":{"id":"Core.Annotations.PathControlHandle.html","title":"Class: PathControlHandle","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: PathControlHandle Core.Annotations. PathControlHandle A control handle that manipulates path-based annotations (Core.Annotations.IPathAnnotation) by moving the points in the path. The annotation must implement the getPath() method. new PathControlHandle(x, y, width, height, pathIndex) Creates a path control handle. Parameters: Name Type Description x number the x coordinate of the point y number the y coordinate of the point width number the width of the handle height number the height of the handle pathIndex number the index of the point in the path array Extends Core.Annotations.ControlHandle Methods draw(ctx, annotation, selectionBox, zoom) Draws the control handle's appearance on the provided canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D the annotation canvas context annotation Core.Annotations.Annotation the annotation to modify selectionBox Core.Math.Rect the selection rect zoom number the current zoom level of the document Inherited From: Core.Annotations.ControlHandle#draw testSelection(annotation, selectionBox, zoom, x, y) Determines if the provided point is a hit on the control handle. See Core.Annotations.SelectionAlgorithm for usuable selection algorithms. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation selectionBox Core.Math.Rect the selection rect zoom number the current zoom level of the document x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates Inherited From: Core.Annotations.ControlHandle#testSelection Returns: true if the provided point is a hit Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.PathSelectionModel.html":{"id":"Core.Annotations.PathSelectionModel.html","title":"Class: PathSelectionModel","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: PathSelectionModel Core.Annotations. PathSelectionModel A selection model for path based annotation implementing the Core.Annotations.IPathAnnotation interface. new PathSelectionModel(annotation, canModify) Creates a path selection model. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation canModify boolean indicates if the annotation can be modified Extends Core.Annotations.SelectionModel Methods canModify() Indicates that the associated annotation is able to be modified Inherited From: Core.Annotations.SelectionModel#canModify Returns: Type boolean drawSelectionOutline(ctx, annotation, zoom) Draws the selection outline of the annotation. By default, a rectangle is drawn based on the annotations x, y, width and height. Parameters: Name Type Description ctx CanvasRenderingContext2D annotation Core.Annotations.Annotation zoom number Inherited From: Core.Annotations.SelectionModel#drawSelectionOutline getControlHandles() Returns the ControlHandle objects associated with this selection model. Inherited From: Core.Annotations.SelectionModel#getControlHandles Returns: An array of ControlHandleObject Type Array.&lt;Core.Annotations.ControlHandle&gt; getDimensions(annotation) Gets the dimensions {x, y, width, height} of the selection bounding box. It may be different from the annotation's bounding box. e.g. The selection bounding box may have a padding. Parameters: Name Type Description annotation Core.Annotations.Annotation Inherited From: Core.Annotations.SelectionModel#getDimensions Returns: Type Core.Math.Rect isSelected() Indicates that the associated annotation is already selected. This can be useful to implement different selection behaviors when an annotation is selected. Inherited From: Core.Annotations.SelectionModel#isSelected Overrides: Core.Annotations.SelectionModel#isSelected Returns: Type boolean testControlHandles(annotation, zoom, x, y) Hit detection for each control handle. Parameters: Name Type Description annotation Core.Annotations.Annotation zoom number x number y number Inherited From: Core.Annotations.SelectionModel#testControlHandles Returns: The control handle that was hit Type Core.Annotations.ControlHandle testSelection(annotation, x, y, pageMatrix, zoom, rotation) Determines if the provided point is a hit on the selected annotationhandle. * See Core.Annotations.SelectionAlgorithm for usuable selection algorithms. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates pageMatrix object the page matrix of the page the annotation is on zoom number the zoom level of the page the annotation is on rotation Core.PageRotation the rotation of the page the annotation is on Inherited From: Core.Annotations.SelectionModel#testSelection Returns: true if the provided point is a hit Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.PolygonAnnotation.html":{"id":"Core.Annotations.PolygonAnnotation.html","title":"Class: PolygonAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: PolygonAnnotation Core.Annotations. PolygonAnnotation new PolygonAnnotation( [initializer]) Represents a Polygon annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.IPathAnnotation Members ArcDrawMode Describes how the arcs of a PolygonCloud annotation will be drawn, can be one of either RANDOM_ARCS or EQUAL_ARCS Type: string Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color Dashes Gets or sets the border dash style of an annotation. e.g '3' or '3,3' Type: string DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified DisplayFormat Gets or sets the annotation's measurement display format. Type: string Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementDisplayFormats = Annotations.Annotation.MeasurementDisplayFormats measurementAnnotation.DisplayFormat = measurementDisplayFormats.FRACTION }); DisplayUnits Gets or sets the annotation's measurement display units. Type: Array.&lt;string&gt; Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementUnits = Annotations.Annotation.MeasurementUnits measurementAnnotation.DisplayUnits = [measurementUnits.FT, measurementUnits.IN] }); elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Intensity Describes intensity of cloudy style effect. 0 for no effect. Type: number Intent Describes the intent of the annotation, e.g PolygonCloud, PolygonDimension Type: string Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Precision Gets or sets the annotation's precision from its measure dictionary. Type: number Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementDisplayFormats = Annotations.Annotation.MeasurementDisplayFormats measurementAnnotation.DisplayFormat = measurementDisplayFormats.FRACTION }); Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled Scale Gets or sets the annotation's scale from its measure dictionary. Type: Array.&lt;any&gt; selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Style Gets or sets the border style of an annotation. e.g Solid, Cloudy Type: string Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject System Gets or sets the annotation's system (Metric, Imperial, Typographic). Type: string Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementSystems = Annotations.Annotation.MeasurementSystems measurementAnnotation.System = measurementSystems.METRIC ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance addPathPoint(x, y) Adds a point to the path Parameters: Name Type Description x number The x coordinate of the point y number The y coordinate of the point Inherited From: Core.Annotations.IPathAnnotation#addPathPoint adjustRect() Recalculate the width and height of the annotation Inherited From: Core.Annotations.IPathAnnotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getBorderStyle() Returns the Border style for the annotation, applicable values are solid (default) and cloudy. Returns: value the string value, either solid or cloudy Type string getCloudIntensity() Returns the intensity of the cloudy style border effect. Returns: value the intensity of the cloud style effect Type number getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getMeasurementCaptionOptions() Gets the measurement annotation's caption options. Returns: The measurement caption options. Type Core.Annotations.measurementCaptionOptions getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getPath() Gets the path array Inherited From: Core.Annotations.IPathAnnotation#getPath Returns: The array of path points Type Array.&lt;Core.Math.Point&gt; getPathPoint(index) Gets the point in the path at the specified index Parameters: Name Type Description index number The index in the path array Inherited From: Core.Annotations.IPathAnnotation#getPathPoint Returns: The path point as an object with x and y properties Type object getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isRectangularPolygon() Gets whether the polygon annotation is rectangular and behaves the same as a rectangle annotation. Returns: true if the polygon annotation is rectangular and behaves the same as a rectangle annotation. Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move popPath() Removes the last point from the path Inherited From: Core.Annotations.IPathAnnotation#popPath Returns: The path point as an object with x and y properties Type object removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; rotate(angle, rotationPoint) Rotate the annotation by angle and origin point to rotate around. Parameters: Name Type Description angle number The angle in radians rotationPoint Core.Math.Point The rotation point to do the rotation around. The default is the center point of the annotation Inherited From: Core.Annotations.IPathAnnotation#rotate serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setBorderStyle(value) Set the Border style for the annotation, applicable values are solid (default) and cloudy. Parameters: Name Type Description value string the string value, either solid or cloudy setCloudIntensity(value) Sets the intensity of cloudy style effect. 0 for no effect. Parameters: Name Type Description value number the intensity value setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setMeasurementCaptionOptions(options) Sets the measurement annotation's caption options. Parameters: Name Type Description options Core.Annotations.measurementCaptionOptions The measurement caption options. Example WebViewer(...) .then(function(instance) { let polygonAnnot = instance.Core.annotationManager.getSelectedAnnotations()[0]; polygonAnnot.setMeasurementCaptionOptions({ isEnabled: true, captionStyle: { staticSize: '0pt', maximumSize: '10pt', color: '#00FFFF' } }) }); setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setPathPoint(index, x, y) Sets the path point at a specific index Parameters: Name Type Description index number The index in the path array to set x number The x coordinate of the point y number The y coordinate of the point Inherited From: Core.Annotations.IPathAnnotation#setPathPoint setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.PolygonControlHandle.html":{"id":"Core.Annotations.PolygonControlHandle.html","title":"Class: PolygonControlHandle","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: PolygonControlHandle Core.Annotations. PolygonControlHandle A control handle that manipulates path-based annotations (Core.Annotations.IPathAnnotation) by moving the points in the path. The annotation must implement the getPath() method. new PolygonControlHandle(x, y, width, height, pathIndex) Creates a polygon control handle. Parameters: Name Type Description x number the x coordinate of the point y number the y coordinate of the point width number the width of the handle height number the height of the handle pathIndex number the index of the point in the path array Extends Core.Annotations.PathControlHandle Methods draw(ctx, annotation, selectionBox, zoom) Draws the control handle's appearance on the provided canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D the annotation canvas context annotation Core.Annotations.Annotation the annotation to modify selectionBox Core.Math.Rect the selection rect zoom number the current zoom level of the document Inherited From: Core.Annotations.ControlHandle#draw testSelection(annotation, selectionBox, zoom, x, y) Determines if the provided point is a hit on the control handle. See Core.Annotations.SelectionAlgorithm for usuable selection algorithms. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation selectionBox Core.Math.Rect the selection rect zoom number the current zoom level of the document x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates Inherited From: Core.Annotations.ControlHandle#testSelection Returns: true if the provided point is a hit Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.PolygonSelectionModel.html":{"id":"Core.Annotations.PolygonSelectionModel.html","title":"Class: PolygonSelectionModel","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: PolygonSelectionModel Core.Annotations. PolygonSelectionModel A selection model for polygon based annotation implementing the Core.Annotations.IPathAnnotation interface. new PolygonSelectionModel(annotation, canModify) Creates a polygon selection model. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation canModify boolean indicates if the annotation can be modified Extends Core.Annotations.PathSelectionModel Methods canModify() Indicates that the associated annotation is able to be modified Inherited From: Core.Annotations.SelectionModel#canModify Returns: Type boolean drawSelectionOutline(ctx, annotation, zoom) Draws the selection outline of the annotation. By default, a rectangle is drawn based on the annotations x, y, width and height. Parameters: Name Type Description ctx CanvasRenderingContext2D annotation Core.Annotations.Annotation zoom number Inherited From: Core.Annotations.SelectionModel#drawSelectionOutline getControlHandles() Returns the ControlHandle objects associated with this selection model. Inherited From: Core.Annotations.SelectionModel#getControlHandles Returns: An array of ControlHandleObject Type Array.&lt;Core.Annotations.ControlHandle&gt; getDimensions(annotation) Gets the dimensions {x, y, width, height} of the selection bounding box. It may be different from the annotation's bounding box. e.g. The selection bounding box may have a padding. Parameters: Name Type Description annotation Core.Annotations.Annotation Inherited From: Core.Annotations.SelectionModel#getDimensions Returns: Type Core.Math.Rect isSelected() Indicates that the associated annotation is already selected. This can be useful to implement different selection behaviors when an annotation is selected. Inherited From: Core.Annotations.SelectionModel#isSelected Returns: Type boolean testControlHandles(annotation, zoom, x, y) Hit detection for each control handle. Parameters: Name Type Description annotation Core.Annotations.Annotation zoom number x number y number Inherited From: Core.Annotations.SelectionModel#testControlHandles Returns: The control handle that was hit Type Core.Annotations.ControlHandle testSelection(annotation, x, y, pageMatrix, zoom, rotation) Determines if the provided point is a hit on the selected annotationhandle. * See Core.Annotations.SelectionAlgorithm for usuable selection algorithms. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates pageMatrix object the page matrix of the page the annotation is on zoom number the zoom level of the page the annotation is on rotation Core.PageRotation the rotation of the page the annotation is on Inherited From: Core.Annotations.SelectionModel#testSelection Returns: true if the provided point is a hit Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.PolylineAnnotation.html":{"id":"Core.Annotations.PolylineAnnotation.html","title":"Class: PolylineAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: PolylineAnnotation Core.Annotations. PolylineAnnotation new PolylineAnnotation( [initializer]) Represents a Polyline annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.IPathAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color Dashes Gets or sets the border dash style of an annotation. e.g '3' or '3,3' Type: string DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified DisplayFormat Gets or sets the annotation's measurement display format. Type: string Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementDisplayFormats = Annotations.Annotation.MeasurementDisplayFormats measurementAnnotation.DisplayFormat = measurementDisplayFormats.FRACTION }); DisplayUnits Gets or sets the annotation's measurement display units. Type: Array.&lt;string&gt; Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementUnits = Annotations.Annotation.MeasurementUnits measurementAnnotation.DisplayUnits = [measurementUnits.FT, measurementUnits.IN] }); elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Precision Gets or sets the annotation's precision from its measure dictionary. Type: number Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementDisplayFormats = Annotations.Annotation.MeasurementDisplayFormats measurementAnnotation.DisplayFormat = measurementDisplayFormats.FRACTION }); Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled Scale Gets or sets the annotation's scale from its measure dictionary. Type: Array.&lt;any&gt; selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Style Gets or sets the border style of an annotation. e.g Solid, Cloudy Type: string Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject System Gets or sets the annotation's system (Metric, Imperial, Typographic). Type: string Example WebViewer(...) .then(function(instance) { const { annotationManager, Annotations } = instance.Core; const measurementAnnotation = annotationManager.getAnnotationsList()[0] const measurementSystems = Annotations.Annotation.MeasurementSystems measurementAnnotation.System = measurementSystems.METRIC ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance addPathPoint(x, y) Adds a point to the path Parameters: Name Type Description x number The x coordinate of the point y number The y coordinate of the point Inherited From: Core.Annotations.IPathAnnotation#addPathPoint adjustRect() Recalculate the width and height of the annotation Inherited From: Core.Annotations.IPathAnnotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getEndStyle() Gets the end style of the polyline Returns: The end style Type Core.Annotations.LineEndType getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getPath() Gets the path array Inherited From: Core.Annotations.IPathAnnotation#getPath Returns: The array of path points Type Array.&lt;Core.Math.Point&gt; getPathPoint(index) Gets the point in the path at the specified index Parameters: Name Type Description index number The index in the path array Inherited From: Core.Annotations.IPathAnnotation#getPathPoint Returns: The path point as an object with x and y properties Type object getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStartStyle() Gets the start style of the polyline Returns: The start style Type Core.Annotations.LineEndType getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move popPath() Removes the last point from the path Inherited From: Core.Annotations.IPathAnnotation#popPath Returns: The path point as an object with x and y properties Type object removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; rotate(angle, rotationPoint) Rotate the annotation by angle and origin point to rotate around. Parameters: Name Type Description angle number The angle in radians rotationPoint Core.Math.Point The rotation point to do the rotation around. The default is the center point of the annotation Inherited From: Core.Annotations.IPathAnnotation#rotate serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setEndStyle(endingStyle) Sets the ending style of the polyline Parameters: Name Type Description endingStyle Core.Annotations.LineEndType The ending style setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setPathPoint(index, x, y) Sets the path point at a specific index Parameters: Name Type Description index number The index in the path array to set x number The x coordinate of the point y number The y coordinate of the point Inherited From: Core.Annotations.IPathAnnotation#setPathPoint setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStartStyle(startStyle) Sets the start style of the polyline Parameters: Name Type Description startStyle Core.Annotations.LineEndType The starting style setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.PopupAnnotation.html":{"id":"Core.Annotations.PopupAnnotation.html","title":"Class: PopupAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: PopupAnnotation Core.Annotations. PopupAnnotation Represents a popup note on an annotation new PopupAnnotation( [initializer]) Creates a new instance of PopupAnnotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.Annotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect close() close the popup annotation deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move open() open the popup annotation removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.RadioButtonWidgetAnnotation.html":{"id":"Core.Annotations.RadioButtonWidgetAnnotation.html","title":"Class: RadioButtonWidgetAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: RadioButtonWidgetAnnotation Core.Annotations. RadioButtonWidgetAnnotation new RadioButtonWidgetAnnotation(field, options) A Radio button widget. Parameters: Name Type Argument Description field Core.Annotations.Forms.Field The field to associate with the widget options object &lt;nullable&gt; A map of properties to set on the widget Extends Core.Annotations.ButtonWidgetAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect createInnerElement() Returns the HTML element of a widget annotation. Override this method to customize the HTML element. Inherited From: Core.Annotations.HTMLAnnotation#createInnerElement Returns: a HTML element Type HTMLElement deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getField() Gets the widget's associated field. Inherited From: Core.Annotations.WidgetAnnotation#getField Returns: The widget's field. Type Core.Annotations.Forms.Field getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getValue() Get the widget's value. Inherited From: Core.Annotations.WidgetAnnotation#getValue Returns: The widget's value (potentially formatted). Type string | number getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element set(options) Set all properties on this widget. Parameters: Name Type Description options Core.Annotations.WidgetAnnotation The set of parameters to set Inherited From: Core.Annotations.WidgetAnnotation#set setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setField(field) Sets the widget's associated field. Parameters: Name Type Description field Core.Annotations.Forms.Field The new field to associate with the widget. Inherited From: Core.Annotations.WidgetAnnotation#setField setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setValue(value) Set and format the widget's value. Parameters: Name Type Argument Description value string | number &lt;nullable&gt; The new value to set Inherited From: Core.Annotations.WidgetAnnotation#setValue setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.RectangleAnnotation.html":{"id":"Core.Annotations.RectangleAnnotation.html","title":"Class: RectangleAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: RectangleAnnotation Core.Annotations. RectangleAnnotation new RectangleAnnotation( [initializer]) Represents a rectangle annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.MarkupAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Intensity Describes intensity of cloudy style effect. 0 for no effect. Type: number Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getBorderStyle() Returns the Border style for the annotation, applicable values are solid (default) and cloudy. Returns: value the string value, either solid or cloudy Type string getCloudIntensity() Returns the intensity of the cloudy style border effect. Returns: value the intensity of the cloud style effect Type number getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setBorderStyle(value) Set the Border style for the annotation, applicable values are solid (default) and cloudy. Parameters: Name Type Description value string the string value, either solid or cloudy setCloudIntensity(value) Sets the intensity of cloudy style effect. 0 for no effect. Parameters: Name Type Description value number the intensity value setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.RedactionAnnotation.html":{"id":"Core.Annotations.RedactionAnnotation.html","title":"Class: RedactionAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: RedactionAnnotation Core.Annotations. RedactionAnnotation new RedactionAnnotation( [options]) Represents a redaction annotation. Parameters: Name Type Argument Description options Object &lt;optional&gt; an initialization object that can contain the following optional parameters. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Properties Name Type Argument Description StrokeColor Core.Annotations.Color &lt;optional&gt; The color of the redaction border before it been applied. This default to red FillColor Core.Annotations.Color &lt;optional&gt; The color of the redaction after it been applied. This default to black TextColor Core.Annotations.Color &lt;optional&gt; The color of the redaction overlay text. The default is red PageNumber number The page number of the redaction Rect Core.Math.Rect &lt;optional&gt; The bounding rectangle of the redaction Quads Array.&lt;Core.Math.Quad&gt; &lt;optional&gt; The individual rectangles of a redaction. For text redactions there might be muliple of these OverlayText string &lt;optional&gt; Text to show after redaction has been applied TextAlign string &lt;optional&gt; the justification of the redaction text (can be 'left', 'center', or 'right') Extends Core.Annotations.TextMarkupAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Font The font to use for the redaction text. Type: string Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable Quads Gets of sets the text quads of the annotation. Type: Array.&lt;Core.Math.Quad&gt; Inherited From: Core.Annotations.TextMarkupAnnotation#Quads ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.RedactionSelectionModel.html":{"id":"Core.Annotations.RedactionSelectionModel.html","title":"Class: RedactionSelectionModel","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: RedactionSelectionModel Core.Annotations. RedactionSelectionModel A selection model for Text annotation. new RedactionSelectionModel(annotation, canModify, isSelected) Creates a text selection model. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation canModify boolean indicates if the annotation can be modified isSelected boolean the annotation is already selected × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.RotationControlHandle.html":{"id":"Core.Annotations.RotationControlHandle.html","title":"Class: RotationControlHandle","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: RotationControlHandle Core.Annotations. RotationControlHandle A control handle based on the bounding box of the annotation used for rotation. The following annotations are supported: Line, Polygon, Polyline, Freehand, Ellipse, Rectangle, Stamp, FreeText new RotationControlHandle(width, height, offset, annotation) Creates a new rotation control handle Parameters: Name Type Description width number The width of the handle height number The height of the handle offset number The minimum offset the control handle will be from the selection box annotation Core.Annotations.Annotation The annotation bound to this control handle Extends Core.Annotations.ControlHandle Methods draw(ctx, annotation, selectionBox, zoom) Draws the control handle's appearance on the provided canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D the annotation canvas context annotation Core.Annotations.Annotation the annotation to modify selectionBox Core.Math.Rect the selection rect zoom number the current zoom level of the document Inherited From: Core.Annotations.ControlHandle#draw testSelection(annotation, selectionBox, zoom, x, y) Determines if the provided point is a hit on the control handle. See Core.Annotations.SelectionAlgorithm for usuable selection algorithms. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation selectionBox Core.Math.Rect the selection rect zoom number the current zoom level of the document x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates Inherited From: Core.Annotations.ControlHandle#testSelection Returns: true if the provided point is a hit Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.RotationUtils.html":{"id":"Core.Annotations.RotationUtils.html","title":"Class: RotationUtils","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: RotationUtils Core.Annotations. RotationUtils new RotationUtils() The namespace for utility functions for annotation rotation. Methods getRotatedBoundingBoxRectFromRectangularAnnotations(unrotatedDimensions, angle, rotationPoint) Parameters: Name Type Description unrotatedDimensions Object An object with the annotation's unrotated dimensions (X, Y, Width and Height). angle number The angle that the annotation in rotated. rotationPoint Core.Math.Point To pivot point for which the annotation is rotated on. Returns: The rect representing the rotated annotation's bounding box. Type Core.Math.Rect getRotatedPointsArray(pointsArray, angle, rotationPoint) Parameters: Name Type Description pointsArray Array.&lt;Core.Math.Point&gt; An array containing the points to be rotated. angle number The angle to rotate the points. rotationPoint Core.Math.Point The pivot point around which the points in the array will be rotated. Returns: An array containing the rotated points. Type Array.&lt;Core.Math.Point&gt; getRotationAngleInDegreesByRadians(angleInRadians) Parameters: Name Type Description angleInRadians number The angle in radians. Returns: The angle in degrees. Type number getRotationAngleInRadiansByDegrees(angleInDegrees) Parameters: Name Type Description angleInDegrees number The angle in degrees. Returns: The angle in radians. Type number getUnrotatedDimensionsFromRectangularAnnotations(rect, angle) Parameters: Name Type Description rect Core.Math.Rect The rect representing the rotated annotation's bounding box. angle number The angle that the annotation in rotated. Returns: An object with the annotation's unrotated dimensions (X, Y, Width and Height). Type Object normalizeAngle(angleInRadians) Parameters: Name Type Description angleInRadians number The angle in radians. Returns: The normalized angle (between 0 and 2*PI) in radians. Type number PathCustomAnnotationRotationMixin() Adds the following methods to a class: rotate: Changes the Rotation property of the annotation, Updates the annotation path and updates the bounding box. adjustRect: Adjusts the annotation's bounding box. serialize / deserialize: Make sure the annotation gets correctly saved into the PDF when downloading the document and that it will load fine. For this mixin to work properly, the annotation class must implement two methods: setPath: Updates the annotation's path (Array of points) getPath: returns the annotation's path (Array of points) RectangularCustomAnnotationRotationMixin() Adds the following methods to a class: rotate: Changes the Rotation property of the annotation and updates the bounding box. getUnrotatedDimensions: Calculates the correct dimension for drawing. getRotatedAnnotationBoundingBoxRect: Calculates the bounding box dimensions. serialize / deserialize: Make sure the annotation gets correctly saved into the PDF when downloading the document and that it will load fine. × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.SelectionAlgorithm.html":{"id":"Core.Annotations.SelectionAlgorithm.html","title":"Class: SelectionAlgorithm","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: SelectionAlgorithm Core.Annotations. SelectionAlgorithm new SelectionAlgorithm() Represents static utility functions to determine hit testing for annotations. Properties: Name Type Default Description canvasVisibilityPadding number 5 Defines a padding for the canvas visibility test algorithm. Increase this value to make selection more forgiving. Methods &lt;static&gt; boundingRectTest(annotation, x, y, zoom) Tests if the provided x and y coordinate is within the annotation's bounding rectangle (x, y, width, height). Parameters: Name Type Default Description annotation Core.Annotations.Annotation x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates zoom number 1 the zoom level to use in the calculation if the annotation has a no zoom property Returns: true if the provided point is a hit on the annotation Type boolean &lt;static&gt; canvasVisibilityTest(annotation, x, y) Tests if the provided x and y coordinate is a visible point on the canvas. Parameters: Name Type Description annotation Core.Annotations.Annotation x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates Returns: true if the provided point is a hit on the annotation Type boolean &lt;static&gt; insidePolygonTest(annotation, x, y, pageMatrix, zoom) Tests if the provided x and y coordinate is inside of the provided polygon annotation Parameters: Name Type Description annotation Core.Annotations.PolygonAnnotation The polygon annotation x number The x-coordinate of the point to test, in page coordinates y number The y-coordinate of the point to test, in page coordinates pageMatrix object The page matrix for the page that the annotation is on. zoom number The zoom level to use in the calculation if the annotation has a no zoom property &lt;static&gt; textQuadTest(annotation, x, y) Tests if the provided x and y coordinate is within a text Quad of the provided text-based annotation. Parameters: Name Type Description annotation Core.Annotations.TextMarkupAnnotation the text markup annotation x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates Returns: true if the provided point is a hit on the annotation Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.SelectionModel.html":{"id":"Core.Annotations.SelectionModel.html","title":"Class: SelectionModel","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: SelectionModel Core.Annotations. SelectionModel Represents a class that contains information about how an annotation should behave when selected. new SelectionModel(annotation, canModify, isSelected, docViewer) Create a new selection model. Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation selected canModify boolean Modification of the annotation is allowed isSelected boolean The annotation is already selected docViewer Core.DocumentViewer An instance of DocumentViewer. Members &lt;static&gt; defaultNoPermissionSelectionOutlineColor Defines the default color for the annotation selection outline when the user is not permitted to make modifications. Type: Core.Annotations.Color &lt;static&gt; defaultSelectionOutlineColor Defines the default color for the annotation selection outline. Type: Core.Annotations.Color &lt;static&gt; selectionAccuracyPadding Defines padding for selection accuracy. Default is 2. Increase this value to make selection more forgiving. Type: number &lt;static&gt; selectionOutlineDashSize Defines the dash size for the selection outline. Default is 4; Type: number &lt;static&gt; selectionOutlineExtraPadding Defines the default padding between selection control points. The padding only appears when the control points are too close. Type: number &lt;static&gt; selectionOutlineThickness Defines thickness of the annotation selection outline. Default is 1. Type: number &lt;static&gt; showPaddingWhenAnnotationIsSmall Defines if extra padding should be shown when the selected annotation is too small. Default is true. Type: boolean &lt;static&gt; useDashedLine Defines if a dashed line style should be used for the selection outline. Default is false. Type: boolean Methods &lt;static&gt; setCustomHandlers(selectionModelClass, selectionModelCustomHandlers) Overwrites the functions in SelectionModel(ex: drawSelectionOutline, getDimensions, testSelection). Parameters: Name Type Description selectionModelClass Core.Annotations.SelectionModel The class (constructor) of the selectionModel selectionModelCustomHandlers Core.Annotations.SelectionModel.SelectionModelCustomHandlers An object containing multiple handlers to overwrite functions on a SelectionModel. Example const { Annotations } = instance.Core; const { SelectionModel, BoxSelectionModel } = Annotations; SelectionModel.setCustomHandlers(BoxSelectionModel, { // draws a diagonal dashed along across the middle of the selected annotation drawSelectionOutline(ctx, annotation, zoom, pageMatrix, { selectionModel, originalDrawSelectionOutline }) { if (!(annotation instanceof Annotations.RectangleAnnotation)) { originalDrawSelectionOutline(ctx, annotation, zoom, pageMatrix); return; } if (typeof zoom !== 'undefined') { ctx.lineWidth = SelectionModel.selectionOutlineThickness / zoom; } else { ctx.lineWidth = SelectionModel.selectionOutlineThickness; } if (selectionModel.canModify()) { ctx.strokeStyle = SelectionModel.defaultSelectionOutlineColor.toString(); } else { ctx.strokeStyle = SelectionModel.defaultNoPermissionSelectionOutlineColor.toString(); } ctx.beginPath(); ctx.moveTo(annotation.X, annotation.Y); ctx.lineTo(annotation.X + annotation.Width, annotation.Y + annotation.Height); ctx.closePath(); ctx.stroke(); const dashUnit = SelectionModel.selectionOutlineDashSize / zoom; const sequence = [dashUnit, dashUnit]; ctx.setLineDash(sequence); ctx.strokeStyle = 'rgb(255, 255, 255)'; ctx.stroke(); }, // Get the dimension that is extended by 8 both horizontally and vertically getDimensions(annotation, { selectionModel, originalGetDimensions }) { if (!(annotation instanceof Annotations.RectangleAnnotation)) { return originalGetDimensions(annotation); } const x = annotation.X - 4; const y = annotation.Y - 4; const width = annotation.Width + 2 * 4; const height = annotation.Height + 2 * 4; return new Annotations.Rect(x, y, x + width, y + height); }, testSelection(annotation, x, y, pageMatrix, zoom, rotation, { selectionModel, originalTestSelection }) { if (annotation instanceof Annotations.RectangleAnnotation) { return originalTestSelection(annotation, x, y, pageMatrix, zoom, rotation);; } return Annotations.SelectionAlgorithm.boundingRectTest(annotation, x, y, zoom); } }) canModify() Indicates that the associated annotation is able to be modified Returns: Type boolean drawSelectionOutline(ctx, annotation, zoom) Draws the selection outline of the annotation. By default, a rectangle is drawn based on the annotations x, y, width and height. Parameters: Name Type Description ctx CanvasRenderingContext2D annotation Core.Annotations.Annotation zoom number getControlHandles() Returns the ControlHandle objects associated with this selection model. Returns: An array of ControlHandleObject Type Array.&lt;Core.Annotations.ControlHandle&gt; getDimensions(annotation) Gets the dimensions {x, y, width, height} of the selection bounding box. It may be different from the annotation's bounding box. e.g. The selection bounding box may have a padding. Parameters: Name Type Description annotation Core.Annotations.Annotation Returns: Type Core.Math.Rect isSelected() Indicates that the associated annotation is already selected. This can be useful to implement different selection behaviors when an annotation is selected. Returns: Type boolean testControlHandles(annotation, zoom, x, y) Hit detection for each control handle. Parameters: Name Type Description annotation Core.Annotations.Annotation zoom number x number y number Returns: The control handle that was hit Type Core.Annotations.ControlHandle testSelection(annotation, x, y, pageMatrix, zoom, rotation) Determines if the provided point is a hit on the selected annotationhandle. * See Core.Annotations.SelectionAlgorithm for usuable selection algorithms. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates pageMatrix object the page matrix of the page the annotation is on zoom number the zoom level of the page the annotation is on rotation Core.PageRotation the rotation of the page the annotation is on Returns: true if the provided point is a hit Type boolean Type Definitions CustomDrawSelectionOutlineHandler(ctx, annotation, zoom, pageMatrix, options) Callback that gets passed to drawSelectionOutlineHandler in setCustomHandlers. Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context annotation Core.Annotations.Annotation The annotation being selected zoom number the current zoom level of the document pageMatrix object The transformation matrix for the page that the annotation is on options object Additional options and parameters Properties Name Type Description selectionModel Core.Annotations.SelectionModel The selection model of the annotation which is currently selected. originalDrawSelectionOutline function The original draw function of this selection model CustomGetDimensionsHandler(annotation, selectionBox, zoom, options) Callback that gets passed to getDimensionsHandler in setCustomHandlers. Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation being selected selectionBox Core.Math.Rect zoom number the current zoom level of the document options object Optional options Properties Name Type Description selectionModel Core.Annotations.SelectionModel The selection model of the annotation which is currently selected. originalGetDimensions function The original getDimensions function of this selection model Returns: Type Core.Math.Rect CustomTestSelectionHandler(x, y, pageMatrix, zoom, rotation, options) Callback that gets passed to testSelectionHandler in setCustomHandlers. Parameters: Name Type Description x number The x-coordinate of the point to test, in page coordinates y number The y-coordinate of the point to test, in page coordinates pageMatrix object the page matrix of the page the annotation is on zoom number The zoom level of the page the annotation is on rotation Core.PageRotation The rotation of the page the annotation is on options object Optional options Properties Name Type Description selectionModel Core.Annotations.SelectionModel The selection model of the annotation which is currently selected. originalTestSelection function The original draw function of this selection model Returns: Type boolean SelectionModelCustomHandlers A collection of functions that overwrite the original functions in SelectionModel Type: object Properties: Name Type Argument Description drawSelectionOutline Core.Annotations.SelectionModel.CustomDrawSelectionOutlineHandler &lt;optional&gt; Changes how a selection model is drawn within WebViewer. getDimensions Core.Annotations.SelectionModel.CustomGetDimensionsHandler &lt;optional&gt; Gets the rect of the selection bounding box. testSelection Core.Annotations.SelectionModel.CustomTestSelectionHandler &lt;optional&gt; Determines if the provided point is a hit on the selected annotation handle. × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.SignatureWidgetAnnotation.html":{"id":"Core.Annotations.SignatureWidgetAnnotation.html","title":"Class: SignatureWidgetAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: SignatureWidgetAnnotation Core.Annotations. SignatureWidgetAnnotation Represents a Signature Widget annotation. new SignatureWidgetAnnotation(field, options) Creates a new instance of SignatureWidgetAnnotation. Parameters: Name Type Argument Description field Core.Annotations.Forms.Field The field to associate with the widget options object &lt;nullable&gt; A map of properties to set on the widget Properties: Name Type Description createSignHereElement function A function that creates the sign here element in the annotation. This can be replaced with your own function. annot object The annotation associated with the signature widget. Extends Core.Annotations.WidgetAnnotation Members annot Get or set the annotation associated with the signature widget. Type: Core.Annotations.FreeHandAnnotation | Core.Annotations.StampAnnotation Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect createInnerElement() Returns the HTML element of a widget annotation. Override this method to customize the HTML element. Inherited From: Core.Annotations.HTMLAnnotation#createInnerElement Returns: a HTML element Type HTMLElement deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getAssociatedSignatureAnnotation() Get the annotation associated with the signature widget. Returns: the annotation associated with the signature widget. Type Core.Annotations.FreeHandAnnotation | Core.Annotations.StampAnnotation getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getField() Gets the widget's associated field. Inherited From: Core.Annotations.WidgetAnnotation#getField Returns: The widget's field. Type Core.Annotations.Forms.Field getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getValue() Get the widget's value. Inherited From: Core.Annotations.WidgetAnnotation#getValue Returns: The widget's value (potentially formatted). Type string | number getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isSignedDigitally() Returns a promise that will be resolved with a boolean value indicating whether the signature widget is signed digitally by default Returns: Type Promise.&lt;any&gt; isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element set(options) Set all properties on this widget. Parameters: Name Type Description options Core.Annotations.WidgetAnnotation The set of parameters to set Inherited From: Core.Annotations.WidgetAnnotation#set setAssociatedSignatureAnnotation(associatedSignatureAnnotation) Get the annotation associated with the signature widget. Parameters: Name Type Description associatedSignatureAnnotation Core.Annotations.FreeHandAnnotation | Core.Annotations.StampAnnotation a freehand annotation or a stamp annotation setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setField(field) Sets the widget's associated field. Parameters: Name Type Description field Core.Annotations.Forms.Field The new field to associate with the widget. Inherited From: Core.Annotations.WidgetAnnotation#setField setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setValue(value) Set and format the widget's value. Parameters: Name Type Argument Description value string | number &lt;nullable&gt; The new value to set Inherited From: Core.Annotations.WidgetAnnotation#setValue setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:44-07:00 using the DocStrap template. "},"Core.Annotations.SoundAnnotation.html":{"id":"Core.Annotations.SoundAnnotation.html","title":"Class: SoundAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: SoundAnnotation Core.Annotations. SoundAnnotation new SoundAnnotation( [initializer]) Represents a sound annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.MarkupAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Icon Gets or sets the icon for this sound annotation. Possible default icon types: SoundWave Type: string Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasAudioData() Returns true if annotation has compressed and encoded audio data attached to it. False otherwise. Returns: Determines if annotation has compressed and encoded audio data attached to it. Type boolean hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move prepareAudioBlob() Decodes, decompresses, converts audio data into a blob, and stores on annotation. Throws: Throws an error if decoding, decompression, or converting to blob fails. Returns: On success, audio blob is stored on annotation. Type Promise.&lt;void&gt; removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:45-07:00 using the DocStrap template. "},"Core.Annotations.StampAnnotation.html":{"id":"Core.Annotations.StampAnnotation.html","title":"Class: StampAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: StampAnnotation Core.Annotations. StampAnnotation new StampAnnotation( [initializer]) Represents a stamp annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.MarkupAnnotation Members &lt;static&gt; IconNames Represents the different stamp icon names that you can use in the useStamp function of RubberStampCreateTool . Properties: Name Type Description APPROVED string Stamp shows Approved AS_IS string Stamp shows AsIs COMPLETED string Stamp shows Compeleted CONFIDENTIAL string Stamp shows Confidential DEPARTMENTAL string Stamp shows Departmental DRAFT string Stamp shows Draft EXPERIMENTAL string Stamp shows Experimental EXPIRED string Stamp shows Expired FINAL string Stamp shows Final FOR_COMMENT string Stamp shows For Comment FOR_PUBLIC_RELEASE string Stamp shows For Public Release INFORMATION_ONLY string Stamp shows Information Only NOT_APPROVED string Stamp shows Not Approved NOT_FOR_PUBLIC_RELEASE string Stamp shows Not For Public Release PRELIMINARY_RESULTS string Stamp shows Preliminary Results SB_REJECTED string Stamp shows Rejected SH_ACCEPTED string Stamp shows Accepted SH_INITIAL_HERE string Stamp shows Initial Here SH_SIGN_HERE string Stamp shows Sign Here SH_WITNESS string Stamp shows Witness SOLD string Stamp shows Sold TOP_SECRET string Stamp shows Top Secret VOID string Stamp shows Void Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Icon Gets or sets the type of the stamp. Type: string Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getImageData() Asynchronously returns the image data URL Returns: a promise that resolves to the image data URL Type Promise.&lt;string&gt; getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getOriginalURL() If this instance of a Stamp Annotation was originally created with a URL in WebViewer, the corresponding URL will be returned Returns: The URL where this stamp originated from Type string getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStampText() Gets the stamp's text Returns: Type string getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setImageData(imageDataUrl [, keepAsSVG]) Asynchronously sets the image URL of the stamp annotation Parameters: Name Type Argument Default Description imageDataUrl string the data URL of the image keepAsSVG boolean &lt;optional&gt; false If image is an SVG data URL then by default it will be converted to PNG to work with other PDF viewers. If this parameter is true then it will not be converted and remain as SVG but will not be visible in other PDF viewers after downloading. Returns: a promise that resolves when the image data URL has been set Type Promise.&lt;void&gt; setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStampText(text) Sets the stamp's text Parameters: Name Type Description text string setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:45-07:00 using the DocStrap template. "},"Core.Annotations.StickyAnnotation.html":{"id":"Core.Annotations.StickyAnnotation.html","title":"Class: StickyAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: StickyAnnotation Core.Annotations. StickyAnnotation new StickyAnnotation( [initializer]) Represents a sticky annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.MarkupAnnotation Members &lt;static&gt; IconNames An enum with possible icon names. Properties: Name Type Description INSERT string CIRCLE string NEW_PARAGRAPH string HELP string KEY string CHECK string CHECKMARK string CROSS string CROSS_HAIRS string PARAGRAPH string RIGHT_ARROW string RIGHT_POINTER string STAR string UP_ARROW string UP_LEFT_ARROW string COMMENT string &lt;static&gt; SIZE The size of the width and height of all sticky annotations Type: number Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Icon The name of the icon to use for this sticky annotation. Possible default icon types: Comment Insert Circle NewParagraph Help Key Check Checkmark Cross CrossHairs Paragraph RightArrow RightPointer Star UpArrow UpLeftArrow Type: string Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel State Gets or sets the state of the annotation. Annotations may have an author-specific state associated with them. State include: Accepted, Rejected, Cancelled, Completed, None. Type: string StateModel Gets or sets the statemodel of the annotation. Statemodel has two statemodels: Marked, Review. Under Marked, state expands to: Marked, Unmarked. Type: string StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getState() Gets the state of the annotation. Returns: the state of the annotation. Type string getStateModel() Gets the statemodel of the annotation. Returns: the statemodel of the annotation. Type string getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setState(state) Sets the state of the annotation. Parameters: Name Type Description state string the state of the annotation. setStateModel(stateModel) Sets the statemodel of the annotation. Parameters: Name Type Description stateModel string the statemodel of the annotation. setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:45-07:00 using the DocStrap template. "},"Core.Annotations.TextHighlightAnnotation.html":{"id":"Core.Annotations.TextHighlightAnnotation.html","title":"Class: TextHighlightAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextHighlightAnnotation Core.Annotations. TextHighlightAnnotation new TextHighlightAnnotation( [initializer]) Represents a text highlight annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Properties: Name Type Description opacityCap number The maximum opacity of all highlight annotations. Extends Core.Annotations.TextMarkupAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable Quads Gets of sets the text quads of the annotation. Type: Array.&lt;Core.Math.Quad&gt; Inherited From: Core.Annotations.TextMarkupAnnotation#Quads ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:45-07:00 using the DocStrap template. "},"Core.Annotations.TextMarkupAnnotation.html":{"id":"Core.Annotations.TextMarkupAnnotation.html","title":"Class: TextMarkupAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextMarkupAnnotation Core.Annotations. TextMarkupAnnotation Represents an extendable text markup annotation. This is the parent class for Highlight, Underline, and Strikeout annotations. new TextMarkupAnnotation( [initializer]) Creates a new instance of TextMarkupAnnotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.MarkupAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable Quads Gets of sets the text quads of the annotation. Type: Array.&lt;Core.Math.Quad&gt; ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:45-07:00 using the DocStrap template. "},"Core.Annotations.TextRedactAnnotation.html":{"id":"Core.Annotations.TextRedactAnnotation.html","title":"Class: TextRedactAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextRedactAnnotation Core.Annotations. TextRedactAnnotation new TextRedactAnnotation( [initializer]) Represents a redaction annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.TextMarkupAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable Quads Gets of sets the text quads of the annotation. Type: Array.&lt;Core.Math.Quad&gt; Inherited From: Core.Annotations.TextMarkupAnnotation#Quads ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:45-07:00 using the DocStrap template. "},"Core.Annotations.TextSelectionModel.html":{"id":"Core.Annotations.TextSelectionModel.html","title":"Class: TextSelectionModel","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextSelectionModel Core.Annotations. TextSelectionModel A selection model for Text annotation. new TextSelectionModel(annotation, canModify) Creates a text selection model. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation canModify boolean indicates if the annotation can be modified Extends Core.Annotations.SelectionModel Methods canModify() Indicates that the associated annotation is able to be modified Inherited From: Core.Annotations.SelectionModel#canModify Returns: Type boolean drawSelectionOutline(ctx, annotation, zoom) Draws the selection outline of the annotation. By default, a rectangle is drawn based on the annotations x, y, width and height. Parameters: Name Type Description ctx CanvasRenderingContext2D annotation Core.Annotations.Annotation zoom number Inherited From: Core.Annotations.SelectionModel#drawSelectionOutline getControlHandles() Returns the ControlHandle objects associated with this selection model. Inherited From: Core.Annotations.SelectionModel#getControlHandles Returns: An array of ControlHandleObject Type Array.&lt;Core.Annotations.ControlHandle&gt; getDimensions(annotation) Gets the dimensions {x, y, width, height} of the selection bounding box. It may be different from the annotation's bounding box. e.g. The selection bounding box may have a padding. Parameters: Name Type Description annotation Core.Annotations.Annotation Inherited From: Core.Annotations.SelectionModel#getDimensions Returns: Type Core.Math.Rect isSelected() Indicates that the associated annotation is already selected. This can be useful to implement different selection behaviors when an annotation is selected. Inherited From: Core.Annotations.SelectionModel#isSelected Overrides: Core.Annotations.SelectionModel#isSelected Returns: Type boolean testControlHandles(annotation, zoom, x, y) Hit detection for each control handle. Parameters: Name Type Description annotation Core.Annotations.Annotation zoom number x number y number Inherited From: Core.Annotations.SelectionModel#testControlHandles Returns: The control handle that was hit Type Core.Annotations.ControlHandle testSelection(annotation, x, y, pageMatrix, zoom, rotation) Determines if the provided point is a hit on the selected annotationhandle. * See Core.Annotations.SelectionAlgorithm for usuable selection algorithms. Parameters: Name Type Description annotation Core.Annotations.Annotation the annotation x number the x-coordinate of the point to test, in page coordinates y number the y-coordinate of the point to test, in page coordinates pageMatrix object the page matrix of the page the annotation is on zoom number the zoom level of the page the annotation is on rotation Core.PageRotation the rotation of the page the annotation is on Inherited From: Core.Annotations.SelectionModel#testSelection Returns: true if the provided point is a hit Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:45-07:00 using the DocStrap template. "},"Core.Annotations.TextSquigglyAnnotation.html":{"id":"Core.Annotations.TextSquigglyAnnotation.html","title":"Class: TextSquigglyAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextSquigglyAnnotation Core.Annotations. TextSquigglyAnnotation Represents a text squiggly annotation. new TextSquigglyAnnotation( [initializer]) Create a new TextSquigglyAnnotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.TextMarkupAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable Quads Gets of sets the text quads of the annotation. Type: Array.&lt;Core.Math.Quad&gt; Inherited From: Core.Annotations.TextMarkupAnnotation#Quads ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:45-07:00 using the DocStrap template. "},"Core.Annotations.TextStrikeoutAnnotation.html":{"id":"Core.Annotations.TextStrikeoutAnnotation.html","title":"Class: TextStrikeoutAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextStrikeoutAnnotation Core.Annotations. TextStrikeoutAnnotation Represents a text strikeout annotation. new TextStrikeoutAnnotation( [initializer]) Creates a new TextStrikeout annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.TextMarkupAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable Quads Gets of sets the text quads of the annotation. Type: Array.&lt;Core.Math.Quad&gt; Inherited From: Core.Annotations.TextMarkupAnnotation#Quads ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:45-07:00 using the DocStrap template. "},"Core.Annotations.TextUnderlineAnnotation.html":{"id":"Core.Annotations.TextUnderlineAnnotation.html","title":"Class: TextUnderlineAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextUnderlineAnnotation Core.Annotations. TextUnderlineAnnotation new TextUnderlineAnnotation( [initializer]) Represents a text underline annotation. Parameters: Name Type Argument Description initializer object &lt;optional&gt; A map of values to auto-initialize certain properties of the annotation. You can only initialize properties defined on the annotation under the Members section (unless specified otherwise). Extends Core.Annotations.TextMarkupAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateCreated Gets or sets the date the annotation was created. Type: Date Inherited From: Core.Annotations.MarkupAnnotation#DateCreated DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName FillColor Gets or sets the color of the annotation's interior. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#FillColor Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsHoverable Gets or sets whether the annotation is hoverable or not. If it is hoverable then the IsHovering property will be true on the annotation when it is currently being hovered. Type: boolean Inherited From: Core.Annotations.MarkupAnnotation#IsHoverable IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom Opacity Gets or sets the opacity of the annotation. Type: number Inherited From: Core.Annotations.MarkupAnnotation#Opacity PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable Quads Gets of sets the text quads of the annotation. Type: Array.&lt;Core.Math.Quad&gt; Inherited From: Core.Annotations.TextMarkupAnnotation#Quads ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel StrokeColor Gets or sets the color of the annotation's stroke. Type: Core.Annotations.Color Inherited From: Core.Annotations.MarkupAnnotation#StrokeColor StrokeThickness Gets or sets the width of the annotation's stroke outline. Type: number Inherited From: Core.Annotations.MarkupAnnotation#StrokeThickness Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName ViewState Gets or sets the viewer state (zoom, rotation, etc) that is associated with the annotation. This state can then be restored in the viewer at a later time. Type: string Inherited From: Core.Annotations.MarkupAnnotation#ViewState Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setStyles(ctx, pageMatrix) Sets the annotation's styles for stroke, fill and opacity on the canvas context Parameters: Name Type Description ctx CanvasRenderingContext2D A canvas context pageMatrix object The transformation matrix for the page that the annotation is on Inherited From: Core.Annotations.MarkupAnnotation#setStyles setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:45-07:00 using the DocStrap template. "},"Core.Annotations.TextWidgetAnnotation.html":{"id":"Core.Annotations.TextWidgetAnnotation.html","title":"Class: TextWidgetAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextWidgetAnnotation Core.Annotations. TextWidgetAnnotation new TextWidgetAnnotation(field, options) Represents a Text Widget annotation. These include boxes and fields where text can be entered. Parameters: Name Type Argument Description field Core.Annotations.Forms.Field The field to associate with the widget options object &lt;nullable&gt; A map of properties to set on the widget Extends Core.Annotations.WidgetAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect createInnerElement() Returns the HTML element of a widget annotation. Override this method to customize the HTML element. Inherited From: Core.Annotations.HTMLAnnotation#createInnerElement Returns: a HTML element Type HTMLElement deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getField() Gets the widget's associated field. Inherited From: Core.Annotations.WidgetAnnotation#getField Returns: The widget's field. Type Core.Annotations.Forms.Field getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getValue() Get the widget's value. Inherited From: Core.Annotations.WidgetAnnotation#getValue Returns: The widget's value (potentially formatted). Type string | number getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element set(options) Set all properties on this widget. Parameters: Name Type Description options Core.Annotations.WidgetAnnotation The set of parameters to set Inherited From: Core.Annotations.WidgetAnnotation#set setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setField(field) Sets the widget's associated field. Parameters: Name Type Description field Core.Annotations.Forms.Field The new field to associate with the widget. Inherited From: Core.Annotations.WidgetAnnotation#setField setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setValue(value) Set and format the widget's value. Parameters: Name Type Argument Description value string | number &lt;nullable&gt; The new value to set Inherited From: Core.Annotations.WidgetAnnotation#setValue setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:45-07:00 using the DocStrap template. "},"Core.Annotations.WidgetAnnotation.html":{"id":"Core.Annotations.WidgetAnnotation.html","title":"Class: WidgetAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: WidgetAnnotation Core.Annotations. WidgetAnnotation Represents an extendable Widget annotation. These annotations contain a field value new WidgetAnnotation() Creates a new instance of WidgetAnnotation. Properties: Name Type Argument Description fieldName string Gets the name of field associated with the widget annotation. value string | number &lt;nullable&gt; Gets or sets the value of the widget annotation (defaults to the field value) defaultValue string | number &lt;nullable&gt; Gets or sets the default value of the field associated with the widget annotation. fieldFlags Core.Annotations.WidgetFlags Gets the flags object of the field associated with this widget. flags Core.Annotations.WidgetFlags Gets the flags object on this widget. font Core.Annotations.Font Gets or sets the font object associated with this widget (defaults to the field's font if not set). appearances object Gets the appearances of this field (currently keys of an object). appearance string Gets or sets the widgets current appearance name. captions object Gets the map of this widget's captions. (Normal is used for the face of PushButtonAnnotations) getCustomStyles function A function that receives the widget object and should return any CSS styles that you want to override getContainerCustomStyles function A function that receives the widget object and should return any CSS styles that you want to override for its parent container Extends Core.Annotations.HTMLAnnotation Members Author The author of the annotation. Type: string Inherited From: Core.Annotations.Annotation#Author Color Gets or sets the annotation's stroke color. Type: Core.Annotations.Color Inherited From: Core.Annotations.Annotation#Color DateModified Gets or sets the date that the annotation was last modified. Type: Date Inherited From: Core.Annotations.Annotation#DateModified elementName Gets or sets the name of the annotation element in XFDF. This property cannot be initialized through the initializer. Type: string Inherited From: Core.Annotations.Annotation#elementName Height Gets or sets the height of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Height Hidden Gets or sets whether the annotation is hidden. Type: boolean Inherited From: Core.Annotations.Annotation#Hidden Id A unique identifier for the annotation. Corresponds to the name attribute in XFDF. Type: string Inherited From: Core.Annotations.Annotation#Id InReplyTo The Id of the annotation that this annotation is replying to or the parent annotation it is grouped with. Type: string Inherited From: Core.Annotations.Annotation#InReplyTo Invisible Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use \"Hidden\". Type: boolean Inherited From: Core.Annotations.Annotation#Invisible IsAdded Gets or sets whether the annotation has been added since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsAdded IsClickableOutsideRect Gets or sets whether any parts of the annotation drawn outside of the rect are clickable. Type: boolean Inherited From: Core.Annotations.Annotation#IsClickableOutsideRect IsDeleted Gets or sets whether the annotation has been deleted since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsDeleted IsModified Gets or sets whether the annotation has been modified since the last time the AnnotCommand was retrieved. Type: boolean Inherited From: Core.Annotations.Annotation#IsModified Listable Gets or sets whether the annotation should be listed in annotation lists. If set to true the annotation also will not be selectable. Type: boolean Inherited From: Core.Annotations.Annotation#Listable Locked Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited. Type: boolean Inherited From: Core.Annotations.Annotation#Locked LockedContents Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#LockedContents MaintainAspectRatio Gets or sets if the annotation maintains aspect ratio when being resized. Type: boolean Inherited From: Core.Annotations.Annotation#MaintainAspectRatio NoDelete Gets or sets if this annotation can be deleted. Type: boolean Inherited From: Core.Annotations.Annotation#NoDelete NoMove Gets or sets whether or not the annotation can be moved. Type: boolean Inherited From: Core.Annotations.Annotation#NoMove NoResize Gets or sets if this annotation can be resized by the user. Type: boolean Inherited From: Core.Annotations.Annotation#NoResize NoRotate Gets or sets if this annotation can be rotated. Type: boolean Inherited From: Core.Annotations.Annotation#NoRotate NoView Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set. Type: boolean Inherited From: Core.Annotations.Annotation#NoView NoZoom Gets or sets if this annotation scales with the page. Type: boolean Inherited From: Core.Annotations.Annotation#NoZoom PageNumber Gets or sets the page number of a document that the annotation appears on. Type: number Inherited From: Core.Annotations.Annotation#PageNumber Printable Gets or sets whether the annotation should be displayed when printing the page. Type: boolean Inherited From: Core.Annotations.Annotation#Printable ReadOnly Gets or sets whether the annotation is readonly or not. If it's readonly it can't be edited or deleted. Type: boolean Inherited From: Core.Annotations.Annotation#ReadOnly ReplyType The type of reply. Type: string Inherited From: Core.Annotations.Annotation#ReplyType Rotation Gets or sets the annotation's clockwise rotation in degrees. Valid values are 0, 90, 180 and 270. Only applies to Stamp, FreeText and Caret annotations. Type: number Inherited From: Core.Annotations.Annotation#Rotation RotationControlEnabled Enabled or disables the annotation's rotation control. Type: boolean Inherited From: Core.Annotations.Annotation#RotationControlEnabled selectionModel Gets or sets a selection model constructor for how an annotation gets selected. Type: Core.Annotations.SelectionModel Inherited From: Core.Annotations.Annotation#selectionModel Subject Represents the subject of the annotation. Default is the annotation's type. Type: string Inherited From: Core.Annotations.Annotation#Subject ToggleNoView Gets or sets whether the ToggleNoView flag is set on the annotation. Type: boolean Inherited From: Core.Annotations.Annotation#ToggleNoView ToolName The name of the tool that is used to create this annotation. Type: string Inherited From: Core.Annotations.Annotation#ToolName Width Gets or sets the width of the annotation. Type: number Inherited From: Core.Annotations.Annotation#Width X Gets or sets the annotation's x-axis position. Type: number Inherited From: Core.Annotations.Annotation#X Y Gets or sets the annotation's y-axis position. Type: number Inherited From: Core.Annotations.Annotation#Y Methods addCustomAppearance(doc [, options]) Adds a custom appearance to the annotation so that the annotation appears like the specified PDF page or object in the PDF page. This appearance will be used instead of the default WebViewer drawing of the annotation. Parameters: Name Type Argument Description doc Core.Document the PDF document object. options object &lt;optional&gt; An object that can contain the following optional parameters. Properties Name Type Argument Default Description pageNumber string &lt;optional&gt; 1 Page number of source document to use for custom appearance. objnum string &lt;optional&gt; The object number from the appearance document. gennum string &lt;optional&gt; The generation number from the appearance document. transparentBackground string &lt;optional&gt; Transparent background, default is true. Inherited From: Core.Annotations.Annotation#addCustomAppearance adjustRect() Adjusts the annotation's bounding rectangle to take into account changes to the annotation e.g. stroke thickness, start/end points, etc Inherited From: Core.Annotations.Annotation#adjustRect createInnerElement() Returns the HTML element of a widget annotation. Override this method to customize the HTML element. Inherited From: Core.Annotations.HTMLAnnotation#createInnerElement Returns: a HTML element Type HTMLElement deleteCustomData(key) Deletes custom data associated with the given key. Parameters: Name Type Description key string The key for which to delete the associated data. Inherited From: Core.Annotations.Annotation#deleteCustomData deserialize(element, pageMatrix) Deserializes the xml element into the annotation Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert PDF coordinates to XOD coordinates. Inherited From: Core.Annotations.Annotation#deserialize disableRotationControl() Disables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#disableRotationControl draw(ctx, pageMatrix) Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page. Parameters: Name Type Description ctx CanvasRenderingContext2D The canvas context prepared to be drawn on. pageMatrix object The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object. Inherited From: Core.Annotations.Annotation#draw enableRotationControl() Enables the rotation control for the annotation Inherited From: Core.Annotations.Annotation#enableRotationControl getContentEditType() Returns the content edit type, if there is one. Only applicable to content edit placeholder annotations. Inherited From: Core.Annotations.Annotation#getContentEditType Returns: Type string getContents() Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation). Inherited From: Core.Annotations.Annotation#getContents Returns: the text content for the annotation. Type string getCustomData(key) Returns custom data associated with the given key. Parameters: Name Type Description key string The key for which to retrieve the associated data. Inherited From: Core.Annotations.Annotation#getCustomData Returns: value The custom data. If no data is available an empty string is returned. Type string getField() Gets the widget's associated field. Returns: The widget's field. Type Core.Annotations.Forms.Field getFormFieldPlaceHolderType() Returns what type of form field place holder it is, if it is a form field place holder Inherited From: Core.Annotations.Annotation#getFormFieldPlaceHolderType Returns: Form field place holder type as described by the Form Field Annotations enum Type string getGroupedChildren() Gets the list of group children to this annotation. Inherited From: Core.Annotations.Annotation#getGroupedChildren Returns: The list of group children Type Array.&lt;Core.Annotations.Annotation&gt; getHeight() Gets the height of the annotation. Inherited From: Core.Annotations.Annotation#getHeight Returns: the height of the annotation. Type number getInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#getInternal Deprecated: Since version 8.3. Use isInternal instead. Returns: Whether the annotation is internal to the document or not Type boolean getPageNumber() Gets the page number of the annotation. Note: page number starts from 1. Inherited From: Core.Annotations.Annotation#getPageNumber Returns: The annotation's page number Type number getRect() Get annotation bounding rectangle Inherited From: Core.Annotations.Annotation#getRect Returns: Type Core.Math.Rect getRectPadding() Gets the padding that will be applied by default on the annotation's rectangle. Inherited From: Core.Annotations.Annotation#getRectPadding Returns: The amount of padding Type number getReplies() Gets the list of replies to this annotation. Inherited From: Core.Annotations.Annotation#getReplies Returns: The list of replies Type Array.&lt;Core.Annotations.Annotation&gt; getRichTextStyle() Gets the rich text style of the annotation. Inherited From: Core.Annotations.Annotation#getRichTextStyle Returns: the current rich text style Type Core.Annotations.Annotation.RichTextStyle getStatus() Gets the status of the annotation, and returns an empty string if no status set. Inherited From: Core.Annotations.Annotation#getStatus Returns: The last status update. Type string getValue() Get the widget's value. Returns: The widget's value (potentially formatted). Type string | number getWidth() Gets the width of the annotation. Inherited From: Core.Annotations.Annotation#getWidth Returns: the width of the annotation. Type number getX() Gets the x position measured in page coordinates of an annotation. Inherited From: Core.Annotations.Annotation#getX Returns: the x position Type number getY() Gets the y position measured in page coordinates. Inherited From: Core.Annotations.Annotation#getY Returns: Type number hasRotationControlEnabled() Returns true if the rotation control is enabled for the annotation and false otherwise. Inherited From: Core.Annotations.Annotation#hasRotationControlEnabled Returns: Type boolean isContentEditPlaceholder() Returns whether the annotation is a content editing placeholder, which are annotations used as placeholders for content edit boxes when the content editing tool is active Inherited From: Core.Annotations.Annotation#isContentEditPlaceholder Returns: Whether the annotation is a content edit placeholder or not Type boolean isFormFieldPlaceholder() Returns whether the annotation is a form field place holder annotation, which are annotations used as place holders for fields in the Form Field Creation mode Inherited From: Core.Annotations.Annotation#isFormFieldPlaceholder Returns: Type boolean isGrouped() Gets whether the annotation is a child of a group Inherited From: Core.Annotations.Annotation#isGrouped Returns: Returns true if the annotation is a child of a group, false otherwise. Type boolean isInternal() Returns true if annotation is part of the original document, false otherwise. Inherited From: Core.Annotations.Annotation#isInternal Returns: Whether the annotation is internal to the document or not Type boolean isPrintVisible() Whether the annotation is visible on the document or not **when printed**. If Hidden or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isPrintVisible Returns: Whether the annotation is visible on the document or not when printed Type boolean isReply() Gets whether the annotation is a reply to another annotation. Inherited From: Core.Annotations.Annotation#isReply Returns: Returns true if it does reply to another annotation, false otherwise. Type boolean isVisible() Whether the annotation is visible on the document or not **when viewing**. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible. Inherited From: Core.Annotations.Annotation#isVisible Returns: Whether the annotation is visible on the document or not when viewing Type boolean move(rect) Move the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#move removeCustomAppearance() Removes the custom appearance of the annotation. Inherited From: Core.Annotations.Annotation#removeCustomAppearance resize(rect) Resize the annotation based on a new given Core.Math.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on resize. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#resize resourcesLoaded() Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images. Inherited From: Core.Annotations.Annotation#resourcesLoaded Returns: A promise that resolves when the resources have finished loading Type Promise.&lt;void&gt; serialize(element, pageMatrix) Serialize the annotation to an xml element Parameters: Name Type Description element Element an xml element representing the annotation pageMatrix object the page matrix used to convert XOD coordinates to PDF coordinates. Inherited From: Core.Annotations.Annotation#serialize Returns: the resulting xml element representing the annotation Type Element set(options) Set all properties on this widget. Parameters: Name Type Description options Core.Annotations.WidgetAnnotation The set of parameters to set setContents(value) Set the text content for the annotation. Note that this will not refresh the text in the UI. Parameters: Name Type Description value string the text content to be set Inherited From: Core.Annotations.Annotation#setContents setCustomData(key, value) Sets the custom data associated with the specified key. Parameters: Name Type Description key string The key under which to store this custom data. Data will automatically be saved in the exported XFDF and merged into the PDF when downloading. value string The custom data to store Inherited From: Core.Annotations.Annotation#setCustomData setField(field) Sets the widget's associated field. Parameters: Name Type Description field Core.Annotations.Forms.Field The new field to associate with the widget. setHeight(value) Sets the height of the annotation. Parameters: Name Type Description value number the height of the annotation. Inherited From: Core.Annotations.Annotation#setHeight setModified( [shouldKeepAppearance]) Flags the annotation as modified if it has been before the last call to exportAnnotationCommand Removes the annotation's appearance if no parameter is passed Should be called if changing a custom property on the annotation that is used for serialization Otherwise the annotation will serialize the original deserialized value Parameters: Name Type Argument Description shouldKeepAppearance boolean &lt;optional&gt; If true then the annotation's appearance will be maintained Inherited From: Core.Annotations.Annotation#setModified setPageNumber(value) Sets the page number of the annotation. Note: page numbers start from 1. Parameters: Name Type Description value number the page number to be set Inherited From: Core.Annotations.Annotation#setPageNumber setRect(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Beware: this method ignores coordinates if they are the wrong way around. (It hasn't been fixed for reasons of maintaining backward compatibility. use setRectWithNormalization instead if you want it to reverse the wrong-way-round coordinates instead of ignoring them.) Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRect setRectWithNormalization(rect) Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them. Parameters: Name Type Description rect Core.Math.Rect the new bounding rectangle Inherited From: Core.Annotations.Annotation#setRectWithNormalization setRichTextStyle(richTextStyle) Sets the rich text style of the annotation. New style will replace the old one Parameters: Name Type Description richTextStyle Core.Annotations.Annotation.RichTextStyle The new rich text style of the annotation Inherited From: Core.Annotations.Annotation#setRichTextStyle setRotationControlEnabled(rotationControlEnabled) Enables or disables the rotation control for the annotation Parameters: Name Type Description rotationControlEnabled boolean true if the rotation control should be enabled Inherited From: Core.Annotations.Annotation#setRotationControlEnabled Deprecated: since version 8.0 Please use enableRotationControl or disableRotationControl instead setValue(value) Set and format the widget's value. Parameters: Name Type Argument Description value string | number &lt;nullable&gt; The new value to set setWidth(value) Sets the width of the annotation. Parameters: Name Type Description value number the width of the annotation. Inherited From: Core.Annotations.Annotation#setWidth setX(value) Sets the x position measured in page coordinates of an annotation. Parameters: Name Type Description value number the x position Inherited From: Core.Annotations.Annotation#setX setY(value) Sets the y position measured in page coordinates. Parameters: Name Type Description value number the y position Inherited From: Core.Annotations.Annotation#setY updateRichTextStyle(object [, startIndex] [, endIndex]) Update the rich text style of the annotation. Can provide a range to set the which characters the style should apply to Parameters: Name Type Argument Description object Core.Annotations.Annotation.StyleObject The new rich text style of the annotation Properties Name Type Description 'underline' boolean boolean value for whether string should be underlined 'line-through' boolean boolean value for whether string should be strike through 'font-weight' string String for the font weight of the rich text (can be 'bold') 'font-style' string String for font style of the rich text (can be 'italic') 'color' string string for what color to set text to startIndex number &lt;optional&gt; Starting character to apply style, if null apply to every character endIndex number &lt;optional&gt; Last character to apply style. If null, apply till end Inherited From: Core.Annotations.Annotation#updateRichTextStyle × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.Annotations.WidgetFlags.html":{"id":"Core.Annotations.WidgetFlags.html","title":"Class: WidgetFlags","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: WidgetFlags Core.Annotations. WidgetFlags new WidgetFlags(options) An object that describes flags on a Widget, or other PDF objects. Parameters: Name Type Argument Description options Object &lt;nullable&gt; Define the set of supported flags. Members &lt;static&gt; COMB If set, the field shall be automatically divided into as many equally spaced positions as the value of the max length. Type: string &lt;static&gt; COMBO If set, the field is a combo box; if clear, the field is a list box. Type: string &lt;static&gt; COMMIT_ON_SEL_CHANGE If set, the new value shall be committed as soon as a selection is made. Type: string &lt;static&gt; DO_NOT_SCROLL If set, the field shall not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle. Type: string &lt;static&gt; DO_NOT_SPELL_CHECK If set, text entered in the field shall not be spell-checked. Type: string &lt;static&gt; EDIT If set, the combo box shall include an editable text box as well as a drop-down list; if clear, it shall include only a drop-down list. Type: string &lt;static&gt; FILE_SELECT If set, the text entered in the field represents the pathname of a file whose contents shall be submitted as the value of the field. Type: string &lt;static&gt; MULTI_SELECT If set, more than one of the field’s option items may be selected simultaneously; if clear, at most one item shall be selected. Type: string &lt;static&gt; MULTILINE If set, the field may contain multiple lines of text. Type: string &lt;static&gt; NO_EXPORT If set, the field shall not be exported by a submit-form action. Type: string &lt;static&gt; NO_TOGGLE_TO_OFF (Radio buttons only) If set, exactly one radio button shall be selected at all times. Type: string &lt;static&gt; PASSWORD If set, the field is intended for entering a secure password that should not be echoed visibly to the screen. Type: string &lt;static&gt; PUSH_BUTTON If set, the field is a pushbutton that does not retain a permanent value. Type: string &lt;static&gt; RADIO If set, the field is a set of radio buttons; if clear, the field is a checkbox. Type: string &lt;static&gt; RADIOS_IN_UNISON If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison. Type: string &lt;static&gt; READ_ONLY If set, the user may not change the value of the field. Type: string &lt;static&gt; REQUIRED If set, the field shall have a value at the time it is exported by a submit-form action. Type: string &lt;static&gt; RICH_TEXT If set, the value of this field shall be a rich text string. Type: string &lt;static&gt; SORT If set, the field’s option items shall be sorted alphabetically. Type: string Methods get(flag) Determine if the given flag is set. Parameters: Name Type Description flag string The name of the flag to check Returns: Whether the flag is set Type boolean set(options [, shouldSet]) Set flags to true or false. If options is an array of strings, set the flags with those names to true. If options is a number or array of numbers, set the flags from the corresponding numbers to true. (deprecated, relies on a limited interpretation of numbers as bitfields) If options is a string, set that flag to shouldSet. Parameters: Name Type Argument Description options Array.&lt;string&gt; | Array.&lt;number&gt; | string | number One of the possible input types to determine which flags to set shouldSet boolean &lt;optional&gt; If options is a string, whether to set or unset the flag × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.Annotations.XFDFUtils.html":{"id":"Core.Annotations.XFDFUtils.html","title":"Class: XFDFUtils","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: XFDFUtils Core.Annotations. XFDFUtils new XFDFUtils() The namespace for utility functions for XFDF serialization and deserialization. Methods &lt;static&gt; deserializeFringeRect(rectString, pageMatrix, separator) Deserializes a fringe rect string into a rect object. Parameters: Name Type Description rectString string Rect in string format. pageMatrix Core.Math.Matrix Object representing the transformation matrix for the page. separator string Separator used for coordinates. Defaults to ',' if not defined. Returns: New Rect with the x and y coordinates. Type Core.Math.Rect &lt;static&gt; deserializeMeasure(measureDictionary) Deserializes the measure XML element into a measure object. Parameters: Name Type Description measureDictionary Element Measure element. Returns: Object with measure information. Type object &lt;static&gt; deserializePoint(pointString, pageMatrix, coordinateSeparator) Deserializes a point string into a point object. Parameters: Name Type Description pointString string Point in string format. pageMatrix Core.Math.Matrix Object representing the transformation matrix for the page. coordinateSeparator string Separator used for coordinates. Defaults to ',' if not defined. Returns: New Point with with an x and y coordinate. Type Core.Math.Point &lt;static&gt; deserializePointArray(pointArrayText, pageMatrix, coordinateSeparator, pointSeparator) Deserializes a list of points in string format into a point array. Parameters: Name Type Description pointArrayText string Array of points in string (delimited by pointSeparator). pageMatrix Core.Math.Matrix Object representing the transformation matrix for the page. coordinateSeparator string Separator used for coordinates. Defaults to ',' if not defined. pointSeparator string Separator used for points. Defaults to ';' if not defined. Returns: Array of Points. Type Array.&lt;Core.Math.Point&gt; &lt;static&gt; deserializeRect(rectString, pageMatrix, separator) Deserializes a rect string into a rect object. Parameters: Name Type Description rectString string Rect in string format. Default value '0,0,0,0'. pageMatrix Core.Math.Matrix Object representing the transformation matrix for the page. separator string Separator used for coordinates. Defaults to ',' if not defined. Returns: New Rect with the x and y coordinates. Type Core.Math.Rect &lt;static&gt; parseDefaultAppearance(da) Parses a default appearance string from an XFDF file and returns an object representing the appearance. Parameters: Name Type Description da string Appearance information in string format. Returns: Appearance information in object format. Type object Example const data = \"0 0 0 rg /Helvetica 40 Tf\"; const response = Annotations.XFDFUtils.parseDefaultAppearance(data); Output: { color: \"#000000\", font: { name: \"Arial\", rawName: \"Helvetica\", size: \"40pt\", }, str: \"0 0 0 rg /Helvetica 40 Tf\", } &lt;static&gt; serializeFringeRect(rect, pageMatrix, separator) Serializes a fringe rect object into a string suitable for an XFDF file. Parameters: Name Type Description rect Core.Math.Rect Rect with the x and y coordinates. pageMatrix Core.Math.Matrix Object representing the transformation matrix for the page. separator string Separator used for coordinates. Defaults to ',' if not defined. Returns: Rect in string format. Type string &lt;static&gt; serializeMeasure(measureDictionary) Serializes the measure object into a measure XML element. Parameters: Name Type Description measureDictionary object Object with measure information. Properties Name Type Description area array Area axis array Axis distance array Distance scale string Scale Returns: Return element. Type Element &lt;static&gt; serializePoint(point, pageMatrix, coordinateSeparator) Serializes the point into a string suitable for an XFDF file. Parameters: Name Type Description point Core.Math.Point Point with an x and y coordinate. pageMatrix Core.Math.Matrix Object representing the transformation matrix for the page. coordinateSeparator string Separator used for coordinates. Defaults to ',' if not defined. Returns: Point in string format. Type string &lt;static&gt; serializePointArray(pointArray, pageMatrix, coordinateSeparator, pointSeparator) Seriarlize the array of points into a string suitable for an XFDF file. Parameters: Name Type Description pointArray Array.&lt;Core.Math.Point&gt; Array of points. pageMatrix Core.Math.Matrix Object representing the transformation matrix for the page. coordinateSeparator string Separator used for coordinates. Defaults to ',' if not defined. pointSeparator string Separator used for points. Defaults to ';' if not defined. Returns: Stringified array of points. Type string &lt;static&gt; serializeRect(rect, pageMatrix, separator) Serializes a rect object into a string suitable for an XFDF file. Parameters: Name Type Description rect Core.Math.Rect Rect with the x and y coordinates. pageMatrix Core.Math.Matrix Object representing the transformation matrix for the page. separator string Separator used for coordinates. Defaults to ',' if not defined. Returns: Rect in string format. Type string &lt;static&gt; toXMLDate(date) Convert a JavaScript date object into a string date that can be used in XFDF Parameters: Name Type Description date Date Date object. Returns: Date in string format. Type string × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.Bookmark.html":{"id":"Core.Bookmark.html","title":"Class: Bookmark","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Bookmark Core. Bookmark Represents a bookmark in a Document. new Bookmark(children, name, pageNumber, parent, verticalOffset, horizontalOffset [, url] [, index] [, objNum]) Bookmarks typically represent an outline of the document, and as each bookmark is usually associated with a specific page in a document, they are typically used to facilitate navigation. Parameters: Name Type Argument Description children Array.&lt;Core.Bookmark&gt; A list of child bookmarks name string The name of the bookmark pageNumber number The page number of the bookmark parent Core.Bookmark The parent bookmark of this bookmark verticalOffset number The vertical position that the linked page will be scrolled to horizontalOffset number The horizontal position that the linked page will be scrolled to url string &lt;optional&gt; An optional parameter that allows the bookmark to link to a URL instead of a page number (this overrides the page number) index number &lt;optional&gt; An optional parameter that indicates the position of the bookmark among its siblings objNum number &lt;optional&gt; The PDF object number of the bookmark Methods getChildren() Gets the children of the bookmark. Returns: The children of the bookmark Type Array.&lt;Core.Bookmark&gt; getHorizontalPosition() Gets the horizontal position of the bookmark. Returns: The horizontal position of the bookmark Type number getHPos() Gets the horizontal position of the bookmark. Deprecated: Since version 8.3. Please use getHorizontalPosition instead Returns: The horizontal position of the bookmark Type number getIndex() Gets the index of the bookmark among its siblings Returns: The index of the bookmark Type number getName() Gets the name of the bookmark. Returns: The name of the bookmark Type string getObjNum() Gets the PDF object number of the bookmark. Returns: The PDF object number of the bookmark Type number getPageNumber() Gets the page number of the bookmark. Returns: The page number of the bookmark Type number getParent() Gets the parent of this bookmark if it has one. Returns: The parent of the bookmark Type Core.Bookmark getURL() Gets the url of the bookmark if it has one. Returns: The url of the bookmark Type string getVerticalPosition() Gets the vertical position of the bookmark. Returns: The vertical position of the bookmark Type number getVPos() Gets the vertical position of the bookmark. Deprecated: Since version 8.3. Please use getVerticalPosition instead Returns: The vertical position of the bookmark Type number isValid() Determines whether the bookmark goes to a valid destination. Returns: Whether the bookmark points to a valid destination Type boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.ContentEdit.html":{"id":"Core.ContentEdit.html","title":"Namespace: ContentEdit","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: ContentEdit Core. ContentEdit The namespace for APIs dealing with document content editing Extends Core.EventHandler Members &lt;static&gt; Events Properties: Name Type Description TEXT_CONTENT_UPDATED string Core.ContentEdit.textContentUpdated &lt;static&gt; Types Content Edit types. Properties: Name Type Description TEXT string Text type content. OBJECT string Object type content. Methods &lt;static&gt; getDocumentContent(contentEditPlaceholderAnnotation) Gets the content box data for the passed in annotation. The passed in annotation must be a content edit placeholder annotation. Parameters: Name Type Description contentEditPlaceholderAnnotation Core.Annotations.RectangleAnnotation Returns: content The document content associated with this content edit placeholder annotation Type Promise.&lt;string&gt; Example const content = await instance.Core.ContentEdit.getDocumentContent(contentEditPlaceholderAnnotation); &lt;static&gt; preloadWorker(documentViewer) Preloads the content editing worker. If this function isn't called then the worker will be loaded when the content editing tool is enabled. Parameters: Name Type Description documentViewer Core.DocumentViewer The DocumentViewer to use as context for the page editing Returns: Resolves after the worker has been loaded Type Promise.&lt;void&gt; &lt;static&gt; updateDocumentContent(contentEditPlaceholderAnnotation, content) Update the document with new content Parameters: Name Type Description contentEditPlaceholderAnnotation Core.Annotations.RectangleAnnotation content string The new content Returns: Resolves after the content has been updated Type Promise.&lt;void&gt; Example instance.Core.ContentEdit.updateDocumentContent(contentEditPlaceholderAnnotation, 'New content'); addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Returns: Returns the object that 'addEventListener' is being called on Type object Example Core.ContentEdit.addEventListener('textContentUpdated', (originalText, updatedText, boundingBoxCoordinates) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Returns: Returns the object that 'removeEventListener' is being called on Type object Example Core.ContentEdit.removeEventListener(); Core.ContentEdit.removeEventListener('textContentUpdated'); Core.ContentEdit.removeEventListener('textContentUpdated', fn); trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Returns: Returns the object that 'trigger' is being called on Type object Example Core.ContentEdit.trigger('textContentUpdated', originalText, updatedText, boundingBoxCoordinates); Events editBoxesAvailable Triggered any time edit boxes are drawn on the page. Parameters: Name Type Description boxes object An array of Content Edit boxes. textContentUpdated Triggered when text content of the page is updated. Parameters: Name Type Description originalText string The original text of the selected bounding box. updatedText string The updated text of the selected bounding box. boundingBoxCoordinates object The coordinates (top, left, bottom, right) of the bounding box. × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.DisplayMode.html":{"id":"Core.DisplayMode.html","title":"Class: DisplayMode","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: DisplayMode Core. DisplayMode Represents a Display Mode. new DisplayMode(docViewer, mode [, scrollable]) Constructs a new Display Mode that specifies how the pages are displayed on the screen Parameters: Name Type Argument Description docViewer object The DocumentViewer instance mode string The display mode type scrollable boolean &lt;optional&gt; (Optional) Whether the display mode is scrollable or not Methods getMode() Returns the current display mode. Returns: The current display mode Type string getPageOffset(pageNumber) Returns the amount the page is offset from its container Parameters: Name Type Description pageNumber number The number of the page Returns: An object with x and y properties of the amount the page is offset from its container Type object getPageTransform(pageNumber) Returns the amount the page is shifted relative to the viewport Parameters: Name Type Description pageNumber number The number of the page Returns: An object with x and y properties of the amount the page is shifted relative to the viewport and width and height properties of the page. Type object getSelectedPages(mousePt1, mousePt2) Gets the indexes of the first and last pages selected. Parameters: Name Type Description mousePt1 object The starting mouse point, an object with x and y properties mousePt2 object The ending mouse point, an object with x and y properties Returns: An object with a 'first' property being the first page selected and a 'last' property being the last page selected. last must be &gt;= first. Type object getVisiblePages( [amountAhead] [, amountSide]) Returns an array of page indexes that are visible on screen. Parameters: Name Type Argument Description amountAhead number &lt;optional&gt; The amount of space ahead of the viewport to count as visible as a multiple of the screen height (default is 0.5) amountSide number &lt;optional&gt; The amount of space to the side of the viewport to count as visible as a multiple of the screen height (default is 0.5) Returns: an array page numbers. Type Array.&lt;number&gt; isContinuous() Returns whether or not the display is continuous Returns: true if the display mode is continuous i.e. shows more than one row at a time Type boolean pageToWindow(pagePt, pageNumber) Converts page coordinates to window coordinates. Parameters: Name Type Description pagePt object A object with x and y properties in page coordinates pageNumber number The page number Returns: An object with the page index as well as x and y values in window coordinates Type object setCustomFunctions() Sets callbacks to provide custom functionality when in custom display mode Parameters: Name Type Description fns.pageToWindow transform coordinates relative to a document page to coordinates relative to the viewer div fns.windowToPage transform coordinates relative to the viewer div relative to a document page fns.getSelectedPages returns an array of currently selected page indices fns.getVisiblePages returns an array of currently visible pages fns.getPageTransform returns the offsets of a page container fns.createPageSections lays out pageSection and pageContainer divs to DocumentViewer can put content in them setParameters(nCols, nRows, currentRow, startRow, endRow) Sets parameters of the display mode Parameters: Name Type Description nCols number The number of columns nRows number The number of rows currentRow number The current row to be displayed startRow number The starting row to have in the DOM endRow number The ending row to have in the DOM windowToPage(windowPt, pageNumber) Converts window coordinates to page coordinates. Parameters: Name Type Description windowPt object A object with x and y properties in window coordinates pageNumber number The page number Returns: An object with the page number as well as x and y values in page coordinates Type object × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.DisplayModeManager.html":{"id":"Core.DisplayModeManager.html","title":"Class: DisplayModeManager","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: DisplayModeManager Core. DisplayModeManager Represents an object that manages the display modes used by DocumentViewer new DisplayModeManager(docViewer) Creates a new instance of DisplayModeManager Parameters: Name Type Description docViewer object The DocumentViewer instance Methods disableVirtualDisplayMode() Disable virtual display mode and switch to non-virtual display mode. This only takes effect after loading a new document (Not on the fly) enableVirtualDisplayMode() Enable virtual display mode and switch to virtual display mode. This only takes effect after loading a new document (Not on the fly) getDisplayMode() Returns the current display mode. Returns: The current display mode. isVirtualDisplayEnabled() Check if virtual display mode for pages is enabled setDisplayMode(displayMode) Sets the display mode. Also removes selection caused by text selection or search. Only renders if a document has been loaded. Parameters: Name Type Description displayMode object The display mode object to set as the current display mode × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.Document.html":{"id":"Core.Document.html","title":"Class: Document","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Document Core. Document Represents a document. new Document(id, type) Constructs a new empty Document, representing a document with individual pages (canvases) that can be displayed on screen and printed. Parameters: Name Type Description id string Unique string identifier for the document type string The type of document that should be instantiated. Values are 'xod' for XOD documents, 'pdf' for PDF, JPG or PNG documents, 'office' for MS Office documents and 'webviewerServer' for WebViewer Server documents Extends Core.EventHandler Methods &lt;static&gt; registerDocumentType(type, source, exposedFuncs) Register new document type with Document class Parameters: Name Type Description type String Name of the new document type source any Class of the new document exposedFuncs Array.&lt;string&gt; An array containing strings of the function names to expose on the document object Returns: Type Boolean &lt;static&gt; unregisterDocumentType(type) Unregister existing document type form Document class Parameters: Name Type Description type String Name of registered document type Returns: Type Boolean addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); applyTemplateValues(templateValues) [Office Document only] Update a Document via binding template keys to content. Parameters: Name Type Description templateValues Core.TemplateData The template replacement values. See: https://www.pdftron.com/documentation/web/guides/generate-via-template/data-model/ for the data model. Returns: Resolves when template data has been applied to the document, or rejects with an error. Type Promise.&lt;void&gt; arePagesAltered() [PDF Document only] Check if the PDF Document has been altered with page modifications (Additions, deletions, rotations, crops). Returns: A boolean value indicating whether the PDF Document has been altered. Type boolean cancelLoadCanvas(id) Cancels the loadCanvasAsync call corresponding to the passed in id Parameters: Name Type Description id number The id returned from the loadCanvasAsync call that will be cancelled. cancelLoadThumbnail(requestId) Cancels the request made for thumbnail with the specified request Id Parameters: Name Type Description requestId number The id returned from loadThumbnailAsync cancelOfflineModeDownload() Cancels a download for offline mode in progress. If there is no current download then this does nothing. cropPages(pageArray, topMargin, botMargin, leftMargin, rightMargin) [PDF Document only] Crop the given pages by the given margins. Note that this method will need to wait for the entire file to be downloaded before the change is applied. Parameters: Name Type Description pageArray Array.&lt;number&gt; an array of page numbers to crop topMargin number how much to crop from the top botMargin number how much to crop from the bottom leftMargin number how much to crop from the left rightMargin number how much to crop from the right Returns: a promise that resolves to an object describing the updated state of the pages in the document Type Promise.&lt;object&gt; disableColorSeparations() [PDF Document only] Disable the color separations feature for rendering. disableOfflineMode() [XOD Document only] Disable offline mode. documentCompletePromise() Deprecated: Since version 8.3. Use getDocumentCompletePromise instead. Returns: A promise that resolves when all of the page information is available for the document Type Promise.&lt;void&gt; enableColorSeparations(options) [PDF Document only] Enables the color separations feature for rendering. the boolean parameter is deprecated since version 8.0 Parameters: Name Type Description options object The options parameter for color separation Properties Name Type Description checkIfBaseColorsUsed boolean Check if the base colors Cyan, Magenta, Yellow and Black are actually used in the document, and if not, prevents the Document.colorSeparationAdded event from firing for one or more of those colors enableOfflineMode() [XOD Document only] Enable offline mode. enableSeparation(name, enabled) [PDF Document only] Enables or disables the rendering of a particular color separation. Parameters: Name Type Description name string The name of the separation enabled boolean Whether to enable or disable the separation extractPages(pageArray [, xfdfString]) [PDF Document only] Extract the given pages from the document. Note that this method will need to wait for the entire file to be downloaded before the change is applied. Parameters: Name Type Argument Description pageArray Array.&lt;number&gt; an array of the page numbers to extract xfdfString string &lt;optional&gt; Optional XFDF string to merge into the document before extracting Returns: a promise that resolves on completion Type Promise.&lt;any&gt; extractPDFNetLayersContext(layers) [PDF Document only][PDFNetJS full only] Get the updated context of a document as a PDFNet object. Parameters: Name Type Description layers layers Returns: a promise that resolves to a PDFNet Context object representing the current layers/OCG state. Type Promise.&lt;object&gt; extractXFDF( [pages]) Gets the XFDF data for the document's internal annotations. Parameters: Name Type Argument Description pages Array.&lt;number&gt; &lt;optional&gt; An array of page numbers to get the XFDF data for the document. Note: Only one page is supported by XOD documents. For PDF documents if no parameter is passed then the XFDF data for the entire document is returned. Returns: A promise that resolves to an object with an xfdfString property and a pages property where pages is the array of page numbers that annotations were extracted from Type Promise.&lt;Core.Document.XFDFInfo&gt; getAuthId() [Server Document only] Get auth Id for current server document. Returns: the auth Id as a string. Type string getBookmarks() Returns an array containing the bookmarks in the document. Returns: A promise resolving to an array containing the bookmarks in the current document. Type Promise.&lt;Array.&lt;Core.Bookmark&gt;&gt; getClientId() [Server Document only] Get client Id for current server document. Returns: the client Id as a string. Type string getColorSeparations() [PDF Document only] Gets the color separations available on this document. Returns: The color separations of the document Type Array.&lt;any&gt; getDestinations() Returns an object containing the destinations of the document. Returns: {Promise} A promise that resolves to an object with document destinations. Type Promise.&lt;object&gt; getDocumentCompletePromise() Returns: A promise that resolves when all of the page information is available for the document Type Promise.&lt;void&gt; getDocumentId() Returns: returns user defined document id passed in WebViewer constructor constorctor or loadDocument API, e.g. WebViewer({ documentId: 'foo-11', initialDoc: 'url' }) or instance.loadDocument(url, { documentId: 'foo-11' }) Type string getDownloadLink( [options]) [PDFTron Server only] Provides a URL to a the PDF with annotations and watermarks merged. Parameters: Name Type Argument Description options Object &lt;optional&gt; An optional object containing download options and parameters. Properties Name Type Argument Description filename string &lt;optional&gt; The preferred name for the downloaded file on the client side. This has no effect on the backend target of the returned link, only the filename used by the browser when the link is accessed. Returns: Will be null if not supported. Otherwise a promise that resolves to an object with a `url` property pointing to the printable PDF. Type Promise.&lt;object&gt; | null getFileData() Asynchronously saves the document and provides the result as an ArrayBuffer. Returns: a promise that resolves to an array buffer containing PDF document bytes. Type Promise.&lt;Array.&lt;any&gt;&gt; getFilename() Get the document filename used for downloading. Returns: filename of the document. Type string getFileSize( [aggressionLevel]) Get the size of the document in bytes. Throws if the size cannot be found. Parameters: Name Type Argument Default Description aggressionLevel number &lt;optional&gt; 2 Set the number of failed attempts to allow before throwing. Each attempt calls a method that may take slighly longer than the previous. The order of attempts are as follows: 1) Return the size immediately if we already have the data 2) Make a HEAD request to the server and attempt to read the 'content-length' header 3) Download the full document and return the size For example, setting aggressionLevel to 1 only tries the first method, setting it to 3 tries all the methods. The default is 2 Returns: The number of bytes Type Promise.&lt;number&gt; getLayersArray() [PDF Document only] Get an array describing the layers/OCG structure in the document. Returns: A promise that resolves to an array representing the layers in the PDF document Type Promise.&lt;Array.&lt;Core.Document.LayerContext&gt;&gt; getLinks(pageNumber) Returns an array containing the links on the specified page of the document. Parameters: Name Type Description pageNumber number The page number, one-indexed, that the links are on. Returns: An array containing the links on the specified page of the document. Type Array.&lt;string&gt; getMetadata() Returns an object with metadata associated with the document. Returns: A promise that resolves to an object with document metadata Type Promise.&lt;object&gt; getOfflineModeEnabled() Returns whether offline mode is currently enabled or not. getPageCount() Returns the number of pages in a document. Returns: The number of the pages in the current document. Type number getPageInfo(pageNumber) Returns an object containing the width and height of a page. Parameters: Name Type Description pageNumber number The page number of the requested page. Returns: An object representing the page info. Contains the properties \"width\" and \"height\". Type Core.Document.PageInfo getPageMatrix(pageNumber) Returns an object representing the transformation matrix for the page. Parameters: Name Type Description pageNumber number The page number of the requested page. Returns: An object representing the page matrix. Type object getPageRotation(pageNumber) Returns the internal degrees of rotation of a page. Parameters: Name Type Description pageNumber number The page number of the requested page. Returns: The internal degrees of rotation of a page. (0, 90, 180 or 270) Type number getPDFCoordinates(pageNumber, x, y) Returns an object with the original x and y coordinates converted to PDF coordinates for the page. Parameters: Name Type Description pageNumber number The page number that the coordinates are on x number The x coordinate y number The y coordinate Returns: An object with the x and y PDF coordinates Type object getPDFDoc() Returns the PDFNet.PDFDoc object associated with the document. Note that the full API is required to be enabled and WebViewer Server cannot be enabled. Returns: A promise that resolves to the PDFDoc object. Type Promise.&lt;Core.PDFNet.PDFDoc&gt; getPrintablePDF() [PDFTron Server only] Provides a URL to a the PDF with annotations and watermarks merged, and an open action specifying that it should be printed. Returns: Will be null if not supported. Otherwise a promise that resolves to an object with a `url` property pointing to the printable PDF. Type Promise.&lt;object&gt; | null getTemplateKeys( [format]) [Office Document only] Provides information about the template keys present in the document. Must have loaded the document with officeOptions.doTemplatePrep, officeOptions.templateValues, or called setTemplatevalues before calling this function. Parameters: Name Type Argument Description format 'flat' | 'schema' | 'locations' &lt;optional&gt; Specifies what type of information to return. Defaults to 'flat'. 'flat' returns a list of all top-level keys used in the document. Keys used in loop bodies are not included in this list, however, this may change in the future. 'schema' returns a detailed schema of the keys used in the document, containing information such as the inferred type of key data. 'locations' returns a collection of the bounding boxes of template content in the document If the template document has been prepped but not filled (officeOptions.doTemplatePrep option has been set), it will return bounding boxes for the template tag text. If the template document has been filled (applyTemplateValues has been called), it will return bounding boxes for the inserted content. Returns: A promise that resolves to the requested data. Type Promise.&lt;(Array.&lt;string&gt;|Core.TemplateSchema|Core.TemplateBoundingBoxes)&gt; getTextByPageAndRect(pageNumber, rect) It returns the text that is within the Rect on the given page Parameters: Name Type Description pageNumber number The page number that the rect is on rect Core.Math.Rect A Rect with x1,y1 representing the top-left and x2,y2 representing the bottom-right Returns: A promise that resolves to the extracted text Type Promise.&lt;string&gt; getTextPosition(pageNumber, textStartIndex, textEndIndex) Gets quads for each of the characters from start to end index. Parameters: Name Type Description pageNumber number The page number that the text is on. textStartIndex number The position where to start getting character quads from. textEndIndex number The position (up to, but not including) where to finish getting characters. Returns: Resolves with quads, which is an array of objects with (x1,y1,x2,y2,x3,y3,x4,y4) Type Promise.&lt;Array.&lt;object&gt;&gt; getType() Gets the type of the document. Returns: The type of the document (xod, pdf, office, webviewerServer) Type string getViewerCoordinates(pageNumber, x, y) Returns an object with the original x and y PDF coordinates converted to Viewer coordinates for the page. Parameters: Name Type Description pageNumber number The page number that the coordinates are on x number The x coordinate y number The y coordinate Returns: An object with the x and y Viewer coordinates Type object getXODCoordinates(pageNumber, x, y) Returns an object with the original x and y PDF coordinates converted to XOD coordinates for the page. Parameters: Name Type Description pageNumber number The page number that the coordinates are on x number The x coordinate y number The y coordinate Returns: An object with the x and y XOD coordinates Type object includesThumbnails() Used to know if a document contains thumbnails. Returns: True if the document contains thumbnails. Type boolean initOfflineDB() [XOD Document only] Initializes the offline database for use. Must be called before any other offline mode functions are used. Returns: Resolves when offline database is ready for use. Type Promise.&lt;void&gt; insertBlankPages(insertBeforeThesePages, width, height) [PDF Document only] Inserts blank pages before the given list of pages. Both width and height are in units of PDF points. Parameters: Name Type Description insertBeforeThesePages Array.&lt;number&gt; array of page numbers before which to insert blanks width number width of the blank pages to insert. By default the width is 612 PDF points. height number height of the blank pages to insert. By default the height is 792 PDF points. Returns: a promise that resolves to an object with info for any pages inserted Type Promise.&lt;object&gt; insertPages(sourceDocument [, pageArray] [, insertBeforeThisPage]) [PDF Document only] Inserts a set of pages from the provided Document before a given page number. Note that this method will need to wait for the entire file to be downloaded before the change is applied. Parameters: Name Type Argument Description sourceDocument Core.Document other document from which to take pages (cannot be the same document) pageArray Array.&lt;number&gt; &lt;optional&gt; An optional array of page numbers to extract from the given document. If not passed in, will insert all pages. insertBeforeThisPage number &lt;optional&gt; An optional page number before which to insert the pages. If not passed in, will append to the end. Returns: a promise that resolves to an object describing the updated state of the pages in the document Type Promise.&lt;object&gt; isDownloaded() [XOD Document only] Whether the document has already been downloaded for offline mode or not. isLinearized() [PDF Document only] Returns whether the document is linearized or not. Note that this only works for documents that are loaded by URL and if useDownloader is not set to false. Returns: Whether the document is linearized or not Type boolean isWebViewerServerDocument() Gets whether the document will be interacted with as a WebViewer Server document This will return false if the document was loaded from WebViewer Server but forceClientSideInit is set to true Returns: Returns whether the document will be interacted with as a WebViewer Server document. Type boolean loadAsync(partRetriever, callback, options) Initialize a Document so that it can be used to load page canvases. Parameters: Name Type Description partRetriever Core.PartRetrievers.PartRetriever An instance of PartRetriever. callback Core.Document.LoadAsyncCallback options an object that can contain the following optional parameters Properties Name Type Argument Description workerTransportPromise Promise.&lt;any&gt; &lt;optional&gt; Required to load a PDF or Office file. A promise that will be resolved when a worker transport has been initialized. This can be created by calling Core.initPDFWorkerTransports or Core.initOfficeWorkerTransports as appropriate. getPassword function &lt;optional&gt; A method of the form function(callback) where callback is of the form function(password). getPassword will be called when a password is required to load a PDF document and should call the callback with the retrieved password. extension string &lt;optional&gt; A field used to specify the type of file being read. This is only relevant for PDF viewing and at the moment only works for certain image formats and .pdf customHandlerId number &lt;optional&gt; A field used to specify PDFTron custom security handler. Its value needs to be an integer in [0, 0xFFFFFFFF]. Returns: Resolves when document is initialized, or rejects with error. Type Promise.&lt;void&gt; loadCanvas(options) Loads a canvas for a particular page number. Parameters: Name Type Description options Object An object specifying the options for loading the canvas. The following parameters should be properties on this object. The only non-optional parameter is pageNumber. Properties Name Type Argument Description pageNumber number The page number of the requested canvas. zoom number &lt;optional&gt; The zoom value to render the page at. getZoom function &lt;optional&gt; A function that returns the zoom value to render the page at. Use this instead of \"zoom\" if the value might change in the process of setting up the canvas. pageRotation Core.PageRotation &lt;optional&gt; The rotation of the page. Valid values are Core.PageRotation.E_0, Core.PageRotation.E_90, Core.PageRotation.E_180, Core.PageRotation.E_270. getPageRotation function &lt;optional&gt; A function that returns the rotation of the page. Use this instead of \"pageRotation\" if the value might change in the process of setting up the canvas. finishedLoading function &lt;optional&gt; A callback called after the list of page resources is retrieved. Return true if rendering should continue, false otherwise. acquireResources function &lt;optional&gt; A function that returns whether resources need to be acquired or not, defaults to true. resourcesLoaded function &lt;optional&gt; A callback called after the page's resources have been loaded. Return true if rendering should continue, false otherwise. getPageTransform function &lt;optional&gt; A function that returns the x and y values of the page's translation. drawComplete function &lt;optional&gt; The callback to call when the canvas has been completely rendered. The first parameter is a canvas object, and the second parameter is the page number. drawProgressive function &lt;optional&gt; The callback to call when the canvas has been partially rendered. renderRect object &lt;optional&gt; An object with x1, y1, x2, y2 properties which is the partial rectangle to render of the entire page. The top left of the page is (0, 0). useProgress boolean &lt;optional&gt; Whether progressive rendering should be used or not. height number &lt;optional&gt; Used to calculate the zoom level if zoom level is not provided. If it's passed the zoom level will be set so the document fits this height. If both width and height are passed the zoom level will be set so the document fits the box delimited by them. width number &lt;optional&gt; Used to calculate the zoom level if zoom level is not provided. If it's passed the zoom level will be set so the document fits this width. If both width and height are passed the zoom level will be set so the document fits the box delimited by them. multiplier number &lt;optional&gt; The quality of the loaded canvas. Must be a positive number. Higher values are higher quality but take longer to complete and use more memory. source string &lt;optional&gt; Indicate the origin of the call. This may be used by the Document's implementation of loadCanvasAsync. Returns: An id that can be passed to the corresponding Pause, Resume or Cancel functions Type string loadCanvasAsync(options) Loads a canvas for a particular page number. Parameters: Name Type Description options Object An object specifying the options for loading the canvas. The following parameters should be properties on this object. The only non-optional parameter is pageNumber. Properties Name Type Argument Description pageNumber number The page number of the requested canvas. zoom number &lt;optional&gt; The zoom value to render the page at. getZoom function &lt;optional&gt; A function that returns the zoom value to render the page at. Use this instead of \"zoom\" if the value might change in the process of setting up the canvas. pageRotation Core.PageRotation &lt;optional&gt; The rotation of the page. Valid values are Core.PageRotation.E_0, Core.PageRotation.E_90, Core.PageRotation.E_180, Core.PageRotation.E_270. getPageRotation function &lt;optional&gt; A function that returns the rotation of the page. Use this instead of \"pageRotation\" if the value might change in the process of setting up the canvas. finishedLoading function &lt;optional&gt; A callback called after the list of page resources is retrieved. Return true if rendering should continue, false otherwise. acquireResources function &lt;optional&gt; A function that returns whether resources need to be acquired or not, defaults to true. resourcesLoaded function &lt;optional&gt; A callback called after the page's resources have been loaded. Return true if rendering should continue, false otherwise. getPageTransform function &lt;optional&gt; A function that returns the x and y values of the page's translation. drawComplete function &lt;optional&gt; The callback to call when the canvas has been completely rendered. The first parameter is a canvas object, and the second parameter is the page number. drawProgressive function &lt;optional&gt; The callback to call when the canvas has been partially rendered. renderRect object &lt;optional&gt; An object with x1, y1, x2, y2 properties which is the partial rectangle to render of the entire page. The top left of the page is (0, 0). useProgress boolean &lt;optional&gt; Whether progressive rendering should be used or not. height number &lt;optional&gt; Used to calculate the zoom level if zoom level is not provided. If it's passed the zoom level will be set so the document fits this height. If both width and height are passed the zoom level will be set so the document fits the box delimited by them. width number &lt;optional&gt; Used to calculate the zoom level if zoom level is not provided. If it's passed the zoom level will be set so the document fits this width. If both width and height are passed the zoom level will be set so the document fits the box delimited by them. multiplier number &lt;optional&gt; The quality of the loaded canvas. Must be a positive number. Higher values are higher quality but take longer to complete and use more memory. source string &lt;optional&gt; Indicate the origin of the call. This may be used by the Document's implementation of loadCanvasAsync. Deprecated: Since version 8.3. Use loadCanvas instead. Returns: An id that can be passed to the corresponding Pause, Resume or Cancel functions Type string loadPageText(pageNumber) Gets all the text on the requested page. Parameters: Name Type Description pageNumber number The page number that the text is on. Returns: A promise that resolves with the page's text. Type Promise.&lt;string&gt; loadThumbnail(pageNumber, onLoadThumbnail) Loads a thumbnail image for a particular page. Parameters: Name Type Description pageNumber number The page number of the requested thumbnail (1-indexed). onLoadThumbnail function The callback to call when the thumbnail has been retrieved. Accepts an HTMLImageElement or HTMLCanvasElement as a parameter. Returns: The id of the request that can later be used for cancelling the request It is passed an image element if the .xod file contains thumbnails and a canvas element otherwise. Type string loadThumbnailAsync(pageNumber, onLoadThumbnail) Loads a thumbnail image for a particular page. Parameters: Name Type Description pageNumber number The page number of the requested thumbnail (1-indexed). onLoadThumbnail function The callback to call when the thumbnail has been retrieved. Accepts an HTMLImageElement or HTMLCanvasElement as a parameter. Deprecated: Since version 8.3. Use loadThumbnail instead. Returns: The id of the request that can later be used for cancelling the request It is passed an image element if the .xod file contains thumbnails and a canvas element otherwise. Type string mergeDocument(source [, position]) [PDF Document only] Merge a file into the currently opened document Parameters: Name Type Argument Description source string | File | ArrayBuffer | Blob Source parameter, path/url to document or File. position number &lt;optional&gt; Optional position for where to merge the document, default to end of file if nothing entered Returns: a promise that resolves on completion Type Promise.&lt;any&gt; movePages(pageArray, insertBeforeThisPage) [PDF Document only] Moves the pages given in an array so they appear in sequence before a given page number. Note that this method will need to wait for the entire file to be downloaded before the change is applied. Parameters: Name Type Description pageArray Array.&lt;number&gt; the page numbers to move insertBeforeThisPage number page number before which to insert the other pages Returns: a promise that resolves to an object describing the updated state of the pages in the document Type Promise.&lt;object&gt; off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); pauseLoadCanvas(id) Pauses the loadCanvasAsync call corresponding to the passed in id Parameters: Name Type Description id number The id returned from the loadCanvasAsync call that will be paused. refreshTextData() Refresh the text data stored by the viewer. Useful if the text content of the document has changed, e.g. after a redaction. removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); removePages(pageArray) [PDF Document only] Removes the given page numbers. Note that this method will need to wait for the entire file to be downloaded before the change is applied. Parameters: Name Type Description pageArray Array.&lt;number&gt; the page numbers to remove Returns: a promise that resolves to an object describing the updated state of the pages in the document Type Promise.&lt;object&gt; requirePage(pageNumber) [PDF Document only] Ensures that a particular page of the pdf document is finished loading before reading, writing or rendering it. Parameters: Name Type Description pageNumber number The page number to ensure completion of loading Returns: a promise that resolves when the page has been loaded Type Promise.&lt;void&gt; resumeLoadCanvas(id) Resumes the loadCanvasAsync call corresponding to the passed in id Parameters: Name Type Description id number The id returned from the loadCanvasAsync call that will be resumed. rotatePages(pageArray, rotation) [PDF Document only] Adds the given rotation to the given pages. Note that this method will need to wait for the entire file to be downloaded before the change is applied. Parameters: Name Type Description pageArray Array.&lt;number&gt; an array of the numbers of pages to rotate rotation Core.PageRotation the page rotation to add Returns: a promise that resolves to an object describing the updated state of the pages in the document Type Promise.&lt;object&gt; setLayersArray(layersContext) [PDF Document only] Update the array describing the layers/OCG structure in order to adjust which layers should be enabled or disabled. The layers updated event is triggered as a side effect Parameters: Name Type Description layersContext Array.&lt;Core.Document.LayerContext&gt; the OCG layers to set setOfflineModeEnabled(enabled) [XOD Document only] Sets whether offline mode is enabled or not. Parameters: Name Type Description enabled boolean The new value for whether offline mode is enabled or not. Deprecated: Since version 8.0. Use enableOfflineMode or disableOfflineMode instead. setOverprintPreviewMode(mode) [PDF Document only] Set the overprint preview mode to be used when rendering this document. Parameters: Name Type Description mode The mode to use. Possible values are Core.OverprintPreviewMode.OFF, Core.OverprintPreviewMode.ON and Core.OverprintPreviewMode.PDFX_ON setTextExtractorProcessingFlags(flags) Sets the flags with which to extract the text from a PDF document. Parameters: Name Type Description flags Array.&lt;number&gt; The flags with which to extract the text from a PDF document. See Core.TextExtractorProcessingFlags setWatermark(options) Sets watermark to be added to the document Parameters: Name Type Description options object Object that contains style/content of the watermark Example doc.setWatermark({ diagonal: { fontSize: (number), fontFamily: (string), color: (string), opacity: (number (between 0 and 100)), text: (string) }, header: { fontSize: (number), fontFamily: (string), color: (string), opacity: (number (between 0 and 100)), left: (string), center: (string), right: (string) }, footer: { fontSize: (number), fontFamily: (string), color: (string), opacity: (number (between 0 and 100)), left: (string), center: (string), right: (string) } custom: (function(ctx, pageIndex, pageWidth, pageHeight)) }); To allow more customization of the header/footer, the following can be done: doc.setWatermark({ diagonal: { fontSize: (number), fontFamily: (string), color: (string), opacity: (number (between 0 and 100)), text: (string) }, headerLeft: { fontSize: (number), fontFamily: (string), color: (string), opacity: (number (between 0 and 100)), text: (string) }, headerCenter: { fontSize: (number), fontFamily: (string), color: (string), opacity: (number (between 0 and 100)), text: (string) }, headerRight: { fontSize: (number), fontFamily: (string), color: (string), opacity: (number (between 0 and 100)), text: (string) }, footerLeft: { fontSize: (number), fontFamily: (string), color: (string), opacity: (number (between 0 and 100)), text: (string) }, footerCenter: { fontSize: (number), fontFamily: (string), color: (string), opacity: (number (between 0 and 100)), text: (string) }, footerRight: { fontSize: (number), fontFamily: (string), color: (string), opacity: (number (between 0 and 100)), text: (string) }, custom: (function(ctx, pageIndex, pageWidth, pageHeight)) }); storeOffline(onComplete, onProgress) [XOD Document only] Downloads the document for offline viewing. Parameters: Name Type Description onComplete function The function that's called when the document has finished being downloaded or the download has been cancelled onProgress function The function that's called on each update in progress of the download. The fraction downloaded is passed as a parameter. (eg 50% downloaded passes 0.5) trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); unloadCanvasResources(id) Unloads resources for the page associated with the loadCanvasAsync call corresponding to the passed in id. So if the loadCanvasAsync call had requested page 2 then page 2's resources will be cleaned up (as long as nothing else requires those resources). Note that the canvas element itself is not touched. Parameters: Name Type Description id number The id returned from the loadCanvasAsync call that will have it's page resources unloaded unloadResources() Cleans up the resources associated with the document. updateRasterizerOptions(options) Update rasterizer options of the document Parameters: Name Type Description options Object Options for this function Properties Name Type Argument Default Description pageTransparent boolean &lt;optional&gt; false Page background transparency. overprintMode number &lt;optional&gt; Core.OverprintPreviewMode.PDFX_ON Enable or disable support for overprint and overprint simulation. antiAliasing boolean &lt;optional&gt; true Enable or disable anti-aliasing. pathHinting boolean &lt;optional&gt; true Enable or disable path hinting. thinLinePixelGridFit boolean &lt;optional&gt; false If true (horizontal/vertical) thin lines will be snapped to integer pixel positions. thinLineStrokeAdjust boolean &lt;optional&gt; true Enable or disable auto stroke adjustment. imageSmoothing boolean &lt;optional&gt; true Enable or disable image smoothing. hqImageResampling boolean &lt;optional&gt; false Whether use a higher quality (but slower) smoothing algorithm. caching boolean &lt;optional&gt; true Enables or disables caching. Caching can improve the rendering performance in cases where the same page will be drawn multiple times. expGamma number &lt;optional&gt; -1.0 The gamma factor used for anti-aliased rendering. It is the exponent value of gamma function. Typical values are in the range from 0.1 to 3. colorPostProcessMode number &lt;optional&gt; Core.ColorPostProcessMode.NONE Set the color post processing transformation. This transform is applied to the rasterized bitmap as the final step in the rasterization process, and is applied directly to the resulting bitmap (disregarding any color space information). Note that this option has no effect when using Core.OverprintPreviewMode.SEPARATION_RENDER. renderAnnots boolean &lt;optional&gt; false Enable or disable annotation and forms rendering (In the viewer, annotation rendering is done separately). highlightFields boolean &lt;optional&gt; false Enable or disable highlighting form fields. This option only has an effect when renderAnnots is true. isPrinting boolean &lt;optional&gt; false Tells the rasterizer to render the page 'print' mode. Certain page elements (such as annotations or OCG-s) are meant to be visible either on the screen or on the printed paper but not both. A common example, is the \"Submit\" button on electronic forms. Returns: returns true if document can update rasterizer options Type boolean Type Definitions LayerContext Type: object Properties: Name Type Description obj string the unique identifier of the layer. This is not defined if the layer is a label name string the name of the layer. It does not have not be unique locked boolean boolean to denote if the layer is locked for viewing. This state cannot be toggled by the user through the user interface visible boolean boolean to denote if the layer is visible children Array.&lt;Core.Document.LayerContext&gt; the layer's children (if any). This is not defined if the layer is a label. LoadAsyncCallback( [error]) The callback to call when the Document has been initialized. If there is an error then an error object will be passed to the callback function. Parameters: Name Type Argument Description error Object &lt;optional&gt; The error that occurs when initializing the document PageInfo Type: Object Properties: Name Type Description width number The width of the page height number The height of the page XFDFInfo Type: Object Properties: Name Type Description xfdfString string The XFDF string pages Array.&lt;number&gt; Array of page numbers that annotations were extracted from Events colorSeparationAdded Triggered when a color separation is loaded and available on the document. Parameters: Name Type Description colorData object An object with properties of the color separation Properties Name Type Description name string The name of the color separation rgb Array.&lt;any&gt; An array containing the R, G and B values for the separation layersUpdated Triggered when a document's layers/OCG structures change visibility. Parameters: Name Type Description layerContext Array.&lt;Core.Document.LayerContext&gt; array of page layers × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.DocumentViewer.html":{"id":"Core.DocumentViewer.html","title":"Class: DocumentViewer","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: DocumentViewer Core. DocumentViewer Represents a full-featured control used for displaying a Document. The viewer supports text selection and text search, and several page view modes. new DocumentViewer() Creates a new empty DocumentViewer. Properties: Name Type Description defaults object Default values for document viewer. Set FitMode, DisplayMode or Zoom. Extends Core.EventHandler Members &lt;static&gt; Events Properties: Name Type Description ACTIVE_SEARCH_RESULT_CHANGED string Core.DocumentViewer.activeSearchResultChanged MOUSE_LEFT_UP string Core.DocumentViewer.mouseLeftUp MOUSE_LEFT_DOWN string Core.DocumentViewer.mouseLeftDown CLICK string Core.DocumentViewer.click TAP string Core.DocumentViewer.tap DBL_CLICK string Core.DocumentViewer.dblClick KEY_DOWN string Core.DocumentViewer.keyDown KEY_UP string Core.DocumentViewer.keyUp MOUSE_ENTER string Core.DocumentViewer.mouseEnter MOUSE_MOVE string Core.DocumentViewer.mouseMove MOUSE_LEAVE string Core.DocumentViewer.mouseLeave MOUSE_RIGHT_DOWN string Core.DocumentViewer.mouseRightDown MOUSE_RIGHT_UP string Core.DocumentViewer.mouseRightUp DOCUMENT_UNLOADED string Core.DocumentViewer.documentUnloaded ANNOTATIONS_LOADED string Core.DocumentViewer.annotationsLoaded BEFORE_DOCUMENT_LOADED string Core.DocumentViewer.beforeDocumentLoaded DOCUMENT_LOADED string Core.DocumentViewer.documentLoaded DISPLAY_PAGE_LOCATION string Core.DocumentViewer.displayPageLocation NOTIFY string Core.DocumentViewer#event:notify SEARCH_IN_PROGRESS string Core.DocumentViewer.searchInProgress TEXT_SELECTED string Core.DocumentViewer.textSelected TOOL_MODE_UPDATED string Core.DocumentViewer.toolModeUpdated FIT_MODE_UPDATED string Core.DocumentViewer.fitModeUpdated ROTATION_UPDATED string Core.DocumentViewer.rotationUpdated ZOOM_UPDATED string Core.DocumentViewer.zoomUpdated PAGE_NUMBER_UPDATED string Core.DocumentViewer.pageNumberUpdated PAGES_UPDATED string Core.DocumentViewer.pagesUpdated PAGE_COMPLETE string Core.DocumentViewer.pageComplete DISPLAY_MODE_UPDATED string Core.DocumentViewer.displayModeUpdated BEGIN_RENDERING string Core.DocumentViewer.beginRendering FINISHED_RENDERING string Core.DocumentViewer.finishedRendering TOOL_UPDATED string Core.DocumentViewer.toolUpdated &lt;static&gt; FitMode Contains a list of available fit modes for the DocumentViewer. Type: function Properties: Name Type Description FitWidth function Zoom level is constrained such that the current page's width will exactly fill the available space. FitPage function Zoom level is constrained such that the current page's width or height will exactly fill the available space. Zoom function Zoom level is not constrained. &lt;static&gt; SearchResults The code indicating the reason that the search process concluded. Properties: Name Type Description ambientStr string The text surrounding the result string. resultStr string The found text. resultStrStart number The index in ambient string where the result string starts. resultStrEnd number The index in ambient string where the result string end. pageNum number The page number which the search was conducted on. resultCode number The reason the search completed. quads object A list of Quads, representing the bounding box(es) of the found text. Useful for highlighting the text. Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); clearSearchResults() Clears all search results from the viewer clearSelection() Clears any selected text on the all pages. closeDocument() Reinitializes data and clears the viewer area content. disableAnnotations() Disable annotations. Annotations in the document will not be visible. disableArrowKeyNavigation() Disable using the left/right arrow keys to switch pages. disableAutomaticLinking() Disable automatic linking. If disabled then any URLs detected in the document text will not automatically be linked. disableGrayscaleAnnotations() Disable viewing annotations in grayscale Deprecated: Yes disableGrayscaleAnnotationsMode() Disable viewing annotations in grayscale disableGrayscaleMode() Disable viewing document in Grayscale disableLoadingAnnotationsFromVisiblePages() If loading annotations from visible pages was previously enabled then calling this function will switch back to the default behavior. disableReadOnlyMode() Disables read-only mode in the viewer. disableRightToLeftPageRendering() Disable right to left page rendering order. disableStylusMode() Disables the stylus annotating mode for all annotation tools. disableViewportRenderMode() Disables viewport rendering mode displayAdditionalSearchResult(result) Displays the new search result without clearing previous results Parameters: Name Type Description result object The result of a search, Core.DocumentViewer.SearchResult Returned by onResult in Core.DocumentViewer#textSearchInit. displayAdditionalSearchResults(results) Displays the new search results without clearing previous results If you need to display many results at the same time this can be much more efficient than calling displayAdditionalSearchResult for each result Parameters: Name Type Description results Array.&lt;object&gt; An array of search results Core.DocumentViewer.SearchResult. Returned by onResult in Core.DocumentViewer#textSearchInit. displayBookmark(bookmark) If the boomark is an internal link then it scrolls the viewer so that the position of the bookmark is in the upper-left corner of the viewer. If it's an external URL then it opens the URL. Parameters: Name Type Description bookmark Bookmark A bookmark that specifies the location to go to. Returned by Core.Document#getBookmarks. displayFirstPage() Scrolls the viewer so that the upper-left corner of the Document's first page is in the upper-left corner of the viewer. displayLastPage() Scrolls the viewer so that the upper-left corner of the Document's last page is in the upper-left corner of the viewer. displayPageLocation(pageNumber, horizontalPosition, verticalPostion [, doNotJumpIfInView]) Shifts the current viewport of the viewer such that it can display the specified viewer coordinate position Please refer to https://www.pdftron.com/documentation/web/guides/coordinates/#viewer-page-coordinates for more details Parameters: Name Type Argument Description pageNumber number The page number the location is on horizontalPosition number The horizontal position from the x-axis origin of the page (in viewer page coordinates) verticalPostion number The vertical position from the y-axis of the page (in viewer page coordinates) doNotJumpIfInView boolean &lt;optional&gt; If true then if the page location is currently in view don't cause the viewer to shift displaySearchResult(result [, jump]) Scrolls the viewer so that the position of the search result is in the middle of the viewer. Parameters: Name Type Argument Description result object The result of a search, Core.DocumentViewer.SearchResult. Returned by onResult in Core.DocumentViewer#textSearchInit. jump function &lt;optional&gt; The callback for navigating to the found result. This is optional and will jump to the correct location in the DocumentViewer if no parameter is passed. dispose() Disposes the current document's data drawSelection(pageNumber) Draws the text selection for the specified page. Should be called after calling AnnotationManager's drawAnnotations function if the selection should still be shown. Parameters: Name Type Description pageNumber number The page number to draw the selection on enableAnnotations() Enable annotations. Any annotations in the document will be visible. enableArrowKeyNavigation() Enable using the left/right arrow keys to switch pages. enableAutomaticLinking() Enable automatic linking. If enabled then any URLs detected in the document text will automatically be linked. enableGrayscaleAnnotations() Enable viewing annotations in grayscale Deprecated: Yes enableGrayscaleAnnotationsMode() Enable viewing annotations in grayscale enableGrayscaleMode() Enable viewing document in Grayscale enableLoadingAnnotationsFromVisiblePages() Enable annotations to only be loaded from the visible pages and removed when a page is no longer visible. Note that when enabling this option only annotations on the visible pages will be exported or included in the downloaded document enableReadOnlyMode() Enables read-only mode in the viewer. In this mode no page manipulation features can be done from thumbnail panel of UI. enableRightToLeftPageRendering() Enable the right to left page rendering order. enableStylusMode() Puts all annotation tools in the stylus annotating mode. When in this mode, finger movements will scroll the document and using a stylus device will annotate the document. enableViewportRenderMode() Enables viewport rendering mode. This only renders the part of the page that is visible within the viewport. getActiveSearchResult() Gets the currently active search result Returns: SearchResult Core.DocumentViewer.SearchResult Type object getAnnotationHistoryManager() Returns the AnnotationHistoryManager used by this DocumentViewer Returns: an instance of AnnotationHistoryManager Type AnnotationHistoryManager getAnnotationManager() Returns the AnnotationManager used by this DocumentViewer Returns: an instance of AnnotationManager Type AnnotationManager getAnnotationsLoadedPromise() Gets a promise that resolves when the annotations in the current document have all been loaded Returns: Promise that resolves when the annotations in the current document have loaded. Type Promise.&lt;any&gt; getColorSeparationsAtPoint(pageNumber, x, y) Gets the color separation values for the specified point. The x and y values should be in page coordinates. Parameters: Name Type Description pageNumber number The page number of the point x number The x value of the point y number The y value of the point Returns: A list of objects which each have the name of the separation and the saturation percentage of the color at the point [{ name, value }, ...] Type Array.&lt;any&gt; getCompleteRotation(pageNumber) Returns the complete rotation of the page including the document's rotation. Parameters: Name Type Description pageNumber number The page number to get that page's rotation Returns: The current complete rotation. Type Core.PageRotation getCurrentPage() Returns the current page number. Returns: The current 1-indexed page number. Type number getDisplayModeManager() Returns the DisplayModeManager used by this DocumentViewer Returns: an instance of DisplayModeManager Type DisplayModeManager getDocument() Returns the Document that is currently being displayed by the viewer. Returns: returns the current document. Type Core.Document getExactViewportRegionRect(pageNumber) Returns the exact viewport rendering region if viewport rendering is enabled. Parameters: Name Type Description pageNumber number The page number Returns: returns the current viewport rendering region Type object getFitMode() Returns the current fit mode. Returns: The current fit mode. Type Core.DocumentViewer.FitMode getMargin() Returns a pixel value, representing the left, right, top and bottom margins. Returns: The margin value. Type number getMeasurementManager() Returns the MeasurementManager used by this DocumentViewer Returns: an instance of MeasurementManager Type MeasurementManager getPageCount() Returns the number of pages in a document. Returns: The number of the pages in the current document. Type number getPageHeight(pageNumber) Get the current height of the specified page, taking into account rotation. Parameters: Name Type Description pageNumber number The page number Returns: The height of the page Type number getPageRotations() Gets the individual page rotations of the document. Only returns pages that have been rotated individually. Returns: An object with keys that are page indexes (1-indexed) and values that are rotation values. Type object getPageSearchResults( [pageNumber]) Get results of the current search Parameters: Name Type Argument Description pageNumber number &lt;optional&gt; page number indicating to return the search hits from a specific page. If it's not given, the function will return search hits from all document pages. Returns: SearchResult array Core.DocumentViewer.SearchResult Type object getPageWidth(pageNumber) Get the current width of the specified page, taking into account rotation. Parameters: Name Type Description pageNumber number The page number Returns: The width of the page Type number getPageZoom(pageNumber) Get the zoom value for a particular page. Parameters: Name Type Description pageNumber number The page number. Returns: Returns page's zoom value Type number getPDFCoordinatesFromMouseEvent(event) Get the PDF coordinates of the current mouse event Parameters: Name Type Description event MouseEvent A DOM mouse event. Returns: Returns an object with the x and y PDF coordinates of the mouse event Type object getRightToLeftPages() Returns whether right to left page rendering is enabled. Deprecated: Since version 8.0. Use isRightToLeftPageRenderingEnabled instead. Returns: The current page rendering order. Type boolean getRotation( [pageNumber]) Returns the current viewing rotation. Parameters: Name Type Argument Description pageNumber number &lt;optional&gt; Optionally pass the page number to get the specific page's rotation Returns: The current viewing rotation. Type Core.PageRotation Example PageRotation['E_0'] = 0 (0 degress) &lt;br/&gt; PageRotation['E_90'] = 1 (90 degress) &lt;br/&gt; PageRotation['E_180'] = 2 (180 degress) &lt;br/&gt; PageRotation['E_270'] = 3 (270 degress) &lt;br/&gt; getScrollViewElement() Gets the scrollview element that is being used by DocumentViewer Returns: The scrollview DOM element that DocumentViewer appends pages Type Element getSelectedText( [pageNumber]) Returns the text selected by text selection tool or search. Parameters: Name Type Argument Description pageNumber number &lt;optional&gt; Optionally pass the 1-indexed page number Returns: Selected text. Type string getSelectedTextQuads( [pageNumber]) Returns the quads of the text selected by text selection tool or search. Parameters: Name Type Argument Description pageNumber number &lt;optional&gt; Optionally pass the 1-indexed page number Returns: Selected text quads. Type object getTool(Name) Returns a specific tool from the tool mode map. Parameters: Name Type Description Name string | Core.Tools.ToolNames of the tool. eg 'AnnotationEdit' Returns: The tool mode map object. Type Core.Tools.Tool getToolMode() Returns the current tool. Returns: The current tool. Type Core.Tools.Tool getToolModeMap() Returns the tool mode map object. Returns: The tool mode map object. Type object getViewerCoordinatesFromMouseEvent(event) Get the viewer page coordinates of the current mouse event Parameters: Name Type Description event MouseEvent A DOM mouse event. Returns: Returns an object with the x and y viewer coordinates of the mouse event Type object getViewerElement() Gets the viewer element that is being used by DocumentViewer Returns: The viewer DOM element that DocumentViewer appends pages Type Element getViewportRegionRect(pageNumber) Returns the current viewport rendering region if viewport rendering is enabled. Parameters: Name Type Description pageNumber number The page number Returns: returns the current viewport rendering region Type object getWatermark() Gets the watermark options that had been previously set. Returns: Returns a promise containing the watermark options. Type Promise.&lt;object&gt; getZoom() Returns the current zoom level Deprecated: Since version 8.3. Use getZoomLevel instead. Returns: The current zoom level. Type number getZoomLevel() Returns the current zoom level. Returns: The current zoom level. Type number isAutomaticLinkingEnabled() Returns whether add automatic link is enabled. Returns: Whether add automatic link is enabled. Type boolean isGrayscaleAnnotationsModeEnabled() Returns whether grayscale annotations mode is enabled for viewing the document Returns: Whether grayscale annotation mode is enabled or not Type boolean isGrayscaleModeEnabled() Returns whether grayscale mode is enabled for viewing the document Returns: Whether grayscale mode is enabled or not Type boolean isInViewportRenderMode() Returns a boolean to denote if viewer is in viewport rendering mode Returns: the boolean to denote if in viewport render mode Type boolean isRightToLeftPageRenderingEnabled() Returns whether right to left page rendering is enabled. Returns: True if right to left page rendering is enabled, false otherwise. Type boolean loadAsync(partRetriever, options) Initialize the viewer and load a .xod document into the viewer. Parameters: Name Type Description partRetriever Core.PartRetrievers.PartRetriever An instance of PartRetriever. options object An object that can contain the following optional parameters Properties Name Type Argument Description type string &lt;optional&gt; The type of document being loaded. Values are xod, pdf, office, webviewerServer. Default is xod. docId string &lt;optional&gt; An optional unique identifier for the document, used for offline mode onError function &lt;optional&gt; A callback of the form function(err) which will be called when a loading error occurs. workerTransportPromise Promise.&lt;void&gt; &lt;optional&gt; Required for PDF viewing. A promise that will be resolved when a worker transport has been initialized. This can be created by calling Core.initializeWorkerTransport getPassword function &lt;optional&gt; An method of the form function(callback) where callback is of the form function(password). getPassword will be called when a password is required to load a PDF document and should call the callback with the retrieved password. extension string &lt;optional&gt; An field used to specify the type of file being read. This is only relevant for PDF viewing and at the moment only works for certain image formats and .pdf licenseKey string &lt;optional&gt; The license key to use. Only necessary for client side and WebViewer Server rendering. loadDocument(src [, options]) Initialize the viewer and load the given file into the viewer. Parameters: Name Type Argument Description src string | File | ArrayBuffer | Blob | Core.Document | Core.PDFNet.PDFDoc Source parameter, path/url to document or File. options Core.CreateDocumentOptions &lt;optional&gt; Load document options. Returns: A promise that resolves when the document is finished loading Type Promise.&lt;void&gt; off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); recalculateLayout(pagesToRecalculate) Request a recalculation of page layout and rerender all pages. For use when modifying the underlying Document without using the provided page modification functions (cropPages, rotatePages...) Parameters: Name Type Description pagesToRecalculate Array.&lt;number&gt; An array of page numbers (1-indexed) that should be recalculated refreshAll() Invalidates the rendering cache for all pages and removes embedded thumbnails for viewer optimized PDF refreshPage(pageNumber) Invalidates the rendering cache for the specified page Parameters: Name Type Description pageNumber number The page number of the page (1-indexed) removeContent(removeData, rotationChanged, isZoomChanged) Removes all the page content from the DOM. Also clear the cache if the zoom or rotation has changed. Parameters: Name Type Description removeData boolean Whether or not to remove all event handlers and data on the elements rotationChanged boolean isZoomChanged boolean removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); rotateClockwise( [pageNumber]) Rotates all pages in the currently displayed document clockwise by 90 degrees. Parameters: Name Type Argument Description pageNumber number &lt;optional&gt; Optionally pass the page number to rotate only a specific page rotateCounterClockwise( [pageNumber]) Rotates all pages in the currently displayed document counter-clockwise by 90 degrees. Parameters: Name Type Argument Description pageNumber number &lt;optional&gt; Optionally pass the page number to rotate only a specific page scrollViewUpdated() This function must be called after modifying the scroll view element's dimensions or properties. The scroll view is the element returned from docViewer.getScrollViewElement() select(pt1, pt2) Selects the text content of the document given two page coordinates. Parameters: Name Type Description pt1 Starting page coordinate. Requires properties x, y and pageNumber. pt2 Ending page coordinate. Requires properties x, y and pageNumber. setActiveSearchResult(result) Sets the active search result, causing it to be displayed as a different color and visible on the screen. Parameters: Name Type Description result object The result of a search, Core.DocumentViewer.SearchResult. Returned by onResult in Core.DocumentViewer#textSearchInit. setAnnotationImportOptions(options) Set the options that are used when importing annotations from a document asynchronously. These are the options that will be passed to AnnotationManager.importAnnotations. Parameters: Name Type Description options object The options for importing Properties Name Type Description batchSize number The number of annotations to import in each batch batchDelay number The amount of time in milliseconds to delay between importing each batch setCurrentPage(pageNumber, isSmoothScroll) Sets the current page. Updates the current page and jumps to it. Parameters: Name Type Description pageNumber number The page number to jump to. isSmoothScroll boolean If set to true, the viewer will scroll in a smooth way. setDefaultPageColor(color) Sets default background color for pages, default is white. Parameters: Name Type Description color string Background color value setDocumentXFDFRetriever(retriever) Sets the XFDF retriever that will be called when a document is being loaded. The XFDF returned from the retriever will be merged into the document. It is recommended to use this function instead of annotManager.importAnnotations if you are loading XFDF from your server so that you don't need to wait for the annotationsLoaded event to be triggered. setDocumentXFDFRetriever will ensure that the annotation data is merged at the right time and as early as possible. Parameters: Name Type Description retriever Core.DocumentViewer.DocumentXFDFRetriever | null A retriever function that returns a Promise which should resolve to the XFDF string that is going to merged into the document Returns: A promise that resolves when the retriever has been set Type Promise.&lt;void&gt; Example instance.docViewer.setDocumentXFDFRetriever(async (documentId) =&gt; { const documentXFDFString = await fetchDocumentXFDFFromServer(documentId); return documentXFDFString; }) setEnableAutomaticLinking(enable) Sets whether automatic linking should be enabled. If enabled then any URLs detected in the document text will automatically be linked. Parameters: Name Type Description enable boolean Whether to enable automatic linking. Deprecated: since version 8.0 Please use enableAutomaticLinking or disableAutomaticLinking instead setEnableStylusMode(enable) Sets if all the annotation tools are in the stylus annotating mode. When in this mode, finger movements will scroll the document and using a stylus device will annotate the document. Parameters: Name Type Description enable boolean a boolean indicating whether stylus annotating mode should be used Deprecated: since version 8.0 Please use enableStylusMode or disableStylusMode instead setEnableStylusMode() Returns whether stylus annotating mode is enabled. Returns: Returns whether stylus annotating mode is enabled Type boolean setFitMode(fitMode) Sets how the document will scale to fit the size of the scrollviewer's viewport. Also re-renders content to the appropriate zoom level. Only renders if a document has been loaded. Parameters: Name Type Description fitMode DocumentViewer.FitMode setInternalAnnotationsTransform(handler) Allows you to transform (or replace) the internal annotations of the document. Note that to handle annotations using PDFNetJS without useDownloader: false you will also want to call setPagesUpdatedInternalAnnotationsTransform Parameters: Name Type Description handler function A handler function that takes annotation data as the first parameter and a callback that is called when the transformed data is ready as the second parameter setLoadAnnotationsFromVisiblePages(val) Sets whether annotations should only be loaded from the visible pages and removed when a page is no longer visible. Note that when enabling this option only annotations on the visible pages will be exported or included in the downloaded document Parameters: Name Type Description val boolean Whether the option should be enabled or not Deprecated: since version 8.0 Please use enableLoadingAnnotationsFromVisiblePages or disableLoadingAnnotationsFromVisiblePages instead setMargin(margin) Set the pixel value to use for the left, right, top and bottom margins. Parameters: Name Type Description margin number The margin value to set. setOptions(options) Sets specific DocumentViewer options. Parameters: Name Type Description options object An options object, currently valid options are enableAnnotations and annotMode Deprecated: Since version 8.3. Use enableAnnotations and disableAnnotations instead. setPageRotations(rotations) Sets the individual page rotations of multiple pages at once. Pages that aren't specified will use the default document rotation. Parameters: Name Type Description rotations object An object with keys that are page indexes (1-indexed) and values that are rotation values. Rotations should be specified as {Core.PageRotation}s setPagesUpdatedInternalAnnotationsTransform(handler) Allows you to transform (or replace) the internal annotations of the document when pages receive an update event. This includes when using PDFNetJS with downloader enabled (default) on a linearized document. For completeness you will also want to call setInternalAnnotationsTransform. Parameters: Name Type Description handler function A handler function that takes annotation data as the first parameter, an array of updated page numbers as a second parameter and a callback that is called when the transformed data is ready as a third parameter setPageVisibilityCallback(callback) Sets the callback function that will be called when a page is newly visible in the viewer. Parameters: Name Type Description callback function A function that takes in a page number indicating the page that is now visible setPageZoom(pageNumber, zoom) Sets the zoom for a particular page. Should be followed by a call to updateView to actually render the page. Parameters: Name Type Description pageNumber number The page number. zoom number Zoom value for page. setRightToLeftPages(rightToLeftPages) Sets the page rendering order. Parameters: Name Type Description rightToLeftPages boolean Whether the new page rendering order should be right to left or not. Deprecated: since version 8.0 Please use enableRightToLeftPageRendering or disableRightToLeftPageRendering instead setRotation(pageRotation [, pageNumber]) Sets the current viewing rotation. Parameters: Name Type Argument Description pageRotation Core.PageRotation desired viewing rotation. pageNumber number &lt;optional&gt; Optionally pass the page number to set the specific page's rotation setScrollViewElement(scrollViewElement) Sets the scrollview element that DocumentViewer will append rendered pages to. Parameters: Name Type Description scrollViewElement Element The scrollview DOM element to be used setSearchHighlightColors(colorOptions) Sets the color to use when highlighting text from searching. Parameters: Name Type Description colorOptions object An object with searchResult or activeSearchResult properties set as a color eg 'rgba(0, 0, 200, 0.5)' Example docViewer.setSearchHighlightColors({ searchResult: 'rgba(255, 0, 0, 0.5)', activeSearchResult: 'rgba(0, 255, 0, 0.5)' }); setSearchPageBatchSize(searchBatchSize) [PDF Document only] Set the number of pages to search at a time. Searching more pages at a time will speed up searching but decrease page rendering responsiveness while a search is ongoing. Default is 50. Parameters: Name Type Description searchBatchSize number The number of pages to search at a time setTextHighlightColor(color) Sets the color to use when highlighting text from text selection. Parameters: Name Type Description color string The color to set. eg 'rgba(0, 0, 200, 0.3)' setToolMode(tool) Sets the tool mode. Also removes selection caused by text selection or search. Parameters: Name Type Description tool Core.Tools.Tool An instance of the toolmode setViewerElement(viewerElement) Sets the viewer element that DocumentViewer will append rendered pages to. Parameters: Name Type Description viewerElement Element The viewer DOM element to be used setViewportRenderMode(val) Sets whether viewport rendering mode should be used Parameters: Name Type Description val boolean Whether viewport rendering mode should be used or not Deprecated: since version 8.0 Please use enableViewportRenderMode or disableViewportRenderMode instead setWatermark(options) Sets watermark to be added to documents. Instead of an options object you can also pass a Promise that resolves with the watermark options object. If the document hasn't been loaded yet then DocumentViewer will wait to finish loading it until the watermark options are ready. Parameters: Name Type Description options object Object that contains style/content of the watermark Properties Name Type Argument Default Description diagonal object &lt;optional&gt; Settings for a diagonal watermark Properties Name Type Argument Default Description text string &lt;optional&gt; The text content to be rendered as a diagonal watermark fontSize number &lt;optional&gt; 20 The font size of the text, measured in pixels (px) fontFamily string &lt;optional&gt; 'sans-serif' The font type color string &lt;optional&gt; 'black' The color of the text opacity number &lt;optional&gt; 100 The percentage of opacity for the watermark header object &lt;optional&gt; Settings for a header watermark Properties Name Type Argument Default Description left string &lt;optional&gt; The text content to be rendered at the left side of the header center string &lt;optional&gt; The text content to be rendered at the center of the header right string &lt;optional&gt; The text content to be rendered at the right side of the header fontSize number &lt;optional&gt; 20 The font size of the text, measured in pixels (px) fontFamily string &lt;optional&gt; 'sans-serif' The font type color string &lt;optional&gt; 'black' The color of the text opacity number &lt;optional&gt; 100 The percentage of opacity for the watermark footer object &lt;optional&gt; Settings for a footer watermark Properties Name Type Argument Default Description left string &lt;optional&gt; The text content to be rendered at the left side of the footer center string &lt;optional&gt; The text content to be rendered at the center of the footer right string &lt;optional&gt; The text content to be rendered at the right side of the footer fontSize number &lt;optional&gt; 20 The font size of the text, measured in pixels (px) fontFamily string &lt;optional&gt; 'sans-serif' The font type color string &lt;optional&gt; 'black' The color of the text opacity number &lt;optional&gt; 100 The percentage of opacity for the watermark custom Core.DocumentViewer.CustomWatermarkCallback &lt;optional&gt; Function that is invoked for each page, to fully customize which page(s) have a watermark render, and how they should be rendered. shouldDrawOverAnnotations boolean &lt;optional&gt; false Toggles if the watermark should be drawn over annotations Example docViewer.setWatermark({ diagonal: { text: (string), fontSize: (number || 20), fontFamily: (string || 'sans-serif'), color: (string || 'black'), opacity: (number || 100) }, header: { left: (string), center: (string), right: (string), fontSize: (number || 20), fontFamily: (string || 'sans-serif'), color: (string || 'black'), opacity: (number || 100) }, footer: { left: (string) center: (string), right: (string), fontSize: (number || 20), fontFamily: (string || 'sans-serif'), color: (string || 'black'), opacity: (number || 100), }, custom: (function(ctx, pageIndex, pageWidth, pageHeight)), shouldDrawOverAnnotations: (boolean || false) }); snapToNearest(pageNumber, x, y [, mode]) Returns the path coordinate within the page that is closest to the queried point. Parameters: Name Type Argument Description pageNumber number The page number the point is on x number The x position to calculate the snap point from y number The y position to calculate the snap point from mode number &lt;optional&gt; Enum for an optional snapping mode for the snapping Returns: A promise that resolves to the SnapData object. Type Promise.&lt;Core.DocumentViewer.SnapData&gt; stopPageRender(pageNumber) Stops the rendering of the specified page. Parameters: Name Type Description pageNumber number The number of the page who's rendering should be stopped. textSearchInit(pattern, mode [, searchOptions]) Searches for a particular text string on the currently displayed Document, starting on the current page unless otherwise specified. Parameters: Name Type Argument Description pattern string The text to search for. mode number The options for search, controlling options such as case sensitivity and search direction. searchOptions object &lt;optional&gt; An object that can contain the following optional parameters Properties Name Type Argument Description fullSearch boolean &lt;optional&gt; If true, a search of the entire document will be performed. Otherwise, a single search will be performed. onResult function &lt;optional&gt; (result) The callback function that is called when the search returns a result. onPageEnd function &lt;optional&gt; (result) The callback function that is called when reaching the end of the page (if using page_stop mode). onDocumentEnd function &lt;optional&gt; () The callback function that is called when reaching the end of the document. onError function &lt;optional&gt; (result) The callback function that is called when search failed or regex has syntax error. startPage number &lt;optional&gt; Page to start the search on (1-indexed). endPage number &lt;optional&gt; Page to end the search on inclusively (1-indexed). The search may complete when the search term is found, when the entire document has been searched, and, depending on the search options, at the end of every page. Parameter result: DocumentViewer.SearchResults. See: Core.DocumentViewer#SearchMode trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); updateLinks(pageNumber) Updates old xod (version Parameters: Name Type Description pageNumber number The 1-indexed page number to update updateView( [visiblePages] [, currentPageNumber]) Removes previously drawn pages that are no longer visible and draws pages that are visible and have not been drawn. If visiblePages are provided then those pages are rendered otherwise visiblePages are calculated depending on where the DIV elements for the pages are located. Parameters: Name Type Argument Description visiblePages Array.&lt;number&gt; &lt;optional&gt; An array of integers representing the pages to render. currentPageNumber number &lt;optional&gt; The number of the page that is currently visible in the viewer. updateVisiblePages( [visiblePages]) Notifies the document viewer that the visible pages have changed but does not draw any pages. Parameters: Name Type Argument Description visiblePages Array.&lt;number&gt; &lt;optional&gt; An array of integers representing the pages to render. zoomTo(zoom [, x] [, y]) Adjusts the viewer's zoom factor, and positions the point (x,y) at the upper left corner of the viewer. Only renders if a document has been loaded. Parameters: Name Type Argument Description zoom number Zoom value. x number &lt;optional&gt; Horizontal position to scroll to. y number &lt;optional&gt; Vertical position to scroll to. zoomToMouse(zoom, offsetX, offsetY) Adjusts the viewer's zoom factor and positions the point on the document under the mouse at the same position after zooming in. Parameters: Name Type Description zoom number Zoom value offsetX number The x offset from the mouse position to the viewer's position (e.g. taking into account toolbars) offsetY number The y offset from the mouse position to the viewer's position (e.g. taking into side panels) Type Definitions CustomWatermarkCallback(ctx, pageIndex, pageWidth, pageHeight) Parameters: Name Type Description ctx CanvasRenderingContext2D The Canvas Context that determines how the watermark will be rendered. Edit the text styles attributes to change the rendering styling. pageIndex number The index of the current page pageWidth number The width of the current page pageHeight number The height of the current page DocumentXFDFRetriever(docId) Parameters: Name Type Description docId string the id of the document that is being loaded Returns: A promise that resolves to an XFDF string, or an array of XFDF commands Type Promise.&lt;(string|Array.&lt;string&gt;)&gt; SnapData Type: Object Properties: Name Type Description x number The x position of the nearestPoint y number The y position of the nearestPoint mode number The effective mode that was used to find this snap point. modeName string The name of the effective mode that was used to find this snap point. Events activeSearchResultChanged Triggered when the active search result has changed Parameters: Name Type Description result object The new active search result, Core.DocumentViewer.SearchResult. annotationsLoaded Triggered when all the annotations embedded in the document have been loaded beforeDocumentLoaded Triggered just before the document has been loaded into the viewer beginRendering Triggered when DocumentViewer starts rendering pages click Triggered for the click event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event dblClick Triggered for the dblClick event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event displayModeUpdated Triggered when the display mode is updated displayPageLocation Triggered when a page location should be displayed Parameters: Name Type Description pageNum number The 1-indexed page number verticalOffset number The offset from the top of the page horizontalOffset number The offset from the left of the page documentLoaded Triggered when a new document has been loaded documentUnloaded Triggered when the current document has been closed and unloaded embeddedThumbnailComplete Triggered when an embedded thumbnail of a viewer-optimized pdf is completely loaded. Parameters: Name Type Description pageNum number The 1-indexed page number finishedRendering Triggered when DocumentViewer finishes rendering pages fitModeUpdated Triggered when the fit mode has changed Parameters: Name Type Description fitMode object The fit mode that has been changed to e.g. docViewer.FitMode.FitWidth keyDown Triggered for the keyDown event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event keyUp Triggered for the keyUp event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseEnter Triggered for the mouseEnter event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseLeave Triggered for the mouseLeave event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseLeftDown Triggered for the mouseLeftButtonDown event in the DocumentViewer's viewing area Attach like docViewer.addEventListener('mouseLeftDown', callback) Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseLeftUp Triggered for the mouseLeftButtonUp event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseMove Triggered for the mouseMove event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseRightDown Triggered for the mouseRightButtonDown event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event mouseRightUp Triggered for the mouseRightButtonUp event in the DocumentViewer's viewing area Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event notify Triggered when there is a notification relating to searching or annotation permissions. Parameters: Name Type Description type string The type of notification that has occurred pageComplete Triggered when a page has been completely rendered. Parameters: Name Type Description pageNum number The 1-indexed page number canvas HTMLCanvasElement The canvas for the page pageNumberUpdated Triggered when the page number is updated Parameters: Name Type Description pageNumber number The new page number (1-indexed) pagesUpdated Triggered when the layout has changed because pages have permanently been added, removed, moved or changed in some other way. Parameters: Name Type Description changes object An object with keys added, removed, moved and contentChanged, indicating which pages have changed rotationUpdated Triggered when the page rotation has changed Parameters: Name Type Argument Description rotation Core.PageRotation The new viewing rotation. pageNumber number &lt;optional&gt; Optionally the specific page number that had its rotation changed searchInProgress Triggered when a search starts or ends. When Core.DocumentViewer#clearSearchResults is executed searchInProgress event is triggered with both inProgress and isFullSearch arguments to be undefined. This can be used to differentiate the search that hasn’t been started versus the search that was done. Parameters: Name Type Description inProgress boolean Whether a search is in progress or not isFullSearch boolean Whether this is a full text search or not searchResultsChanged Triggered when the search results list has changed Parameters: Name Type Description results Array.&lt;object&gt; The new search results, Core.DocumentViewer.SearchResult. tap Triggered when there is a tap in the DocumentViewer's viewing area. Taps are defined as a mouse down and up within a short time period and within a short distance.a Parameters: Name Type Description nativeEvt object Event object of the native JavaScript event textSelected Triggered when the selected text has changed Parameters: Name Type Description quads Array.&lt;Core.Math.Quad&gt; An array of bounding box quads of the selected text text string The selected text pageNumber number The page number that the text was selected on toolModeUpdated Triggered when the tool mode has changed Parameters: Name Type Description newToolObject object The tool object that has been changed to. oldToolObject object The tool object that has been changed from. toolUpdated Triggered when the tool styles or tool name have changed Parameters: Name Type Description toolModeClass object The tool object that has been changed. zoomUpdated Triggered when the zoom level has been updated Parameters: Name Type Description zoom number The new zoom level of the viewer × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.EditBoxManager.html":{"id":"Core.EditBoxManager.html","title":"Class: EditBoxManager","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: EditBoxManager Core. EditBoxManager A manager class that controls freetext annotation contents editing. new EditBoxManager() Extends EventHandler Type Definitions Range Type: Object Properties: Name Type Description index number the index of cursor length number the number of characters that are selected Events editorBlur Triggered after an editor blurred Parameters: Name Type Description editor Core.Annotations.FreeTextAnnotation.RichTextEditor an instance of Editor annotation Core.Annotations.FreeTextAnnotation a freetext annotation editorFocus Triggered after an editor is focused Parameters: Name Type Description editor Core.Annotations.FreeTextAnnotation.RichTextEditor an instance of Editor annotation Core.Annotations.FreeTextAnnotation a freetext annotation editorSelectionChanged Triggered after selection in the editor changed Parameters: Name Type Description range Core.EditBoxManager.Range current selected range oldRange Core.EditBoxManager.Range previous selected range editorTextChanged Triggered after some text in the editor changed × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.EventHandler.html":{"id":"Core.EventHandler.html","title":"Class: EventHandler","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: EventHandler Core. EventHandler new EventHandler() Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.Math.html":{"id":"Core.Math.html","title":"Namespace: Math","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: Math Core. Math Contains helpful classes to work with position, dimensions, and transformations. Example WebViewer(...) .then(function(instance) { var Math = instance.Core.Math; // Math.Point }); Classes Matrix Point Quad Rect TransformationBuilder × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.Math.Matrix.html":{"id":"Core.Math.Matrix.html","title":"Class: Matrix","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Matrix Core.Math. Matrix A utility class that represents transformations and transformation states. new Matrix(Rows, Columns) Creates a new Matrix. Parameters: Name Type Description Rows number the number of rows Columns number the number of columns Properties: Name Type Description Rows number the number of rows Columns number the number of columns Members &lt;static&gt; Identity Returns a 3x3 identity matrix. Methods &lt;static&gt; createTransformWithRespectTo(transforms [, origin]) Multiples a series of transformations to create a final transformation matrix. Optionally, provide a point to transform with respect to. Note that the order of transformations in the array matters and should be the logical order you expect them to execute in. Parameters: Name Type Argument Description transforms Array.&lt;Core.Math.Matrix&gt; An array of ordered transformations origin Core.Math.Point &lt;optional&gt; A point to transform with respect to. Default: (0, 0) Returns: The result matrix Type Core.Math.Matrix &lt;static&gt; fromMatrix2D(mat2d) Creates a matrix from Matrix2D. Parameters: Name Type Description mat2d Core.PDFNet.Matrix2D The PDFNet matrix Returns: The matrix that represents the original Type Core.Math.Matrix &lt;static&gt; multiply(left, right) Multiplies two matrices together Parameters: Name Type Description left Core.Math.Matrix The left matrix right Core.Math.Matrix The right Matrix Returns: The result matrix Type Core.Math.Matrix clone() Clones this matrix. Returns: A clone of this matrix determinent() Calculates the determinant of the matrix. Only works for 3x3! Returns: The determinant Type number get(row, column) Gets a value in a particular cell in the matrix. Parameters: Name Type Description row number The row number column number The column number Returns: Type number inverse() Get an inverse matrix. This is helpful for reversing transformations. This function will return null if no inverse was found. Returns: The inverse matrix of this matrix Type Core.Math.Matrix multiply(rightMatrix) Multiples this matrix (left) against another matrix (right). Parameters: Name Type Description rightMatrix Core.Math.Matrix The other matrix Returns: The result matrix Type Core.Math.Matrix set(row, column, val) Sets the value in a particular cell in the matrix. Parameters: Name Type Description row number The row number column number The column number val number The number to set setRotation(angle [, inRadians]) Sets the rotational values of the matrix. Parameters: Name Type Argument Default Description angle number The amount to rotate by. inRadians boolean &lt;optional&gt; false Whether the amount is in radians. Default: false setScale(sx, sy) Sets the scale transformation values. Parameters: Name Type Description sx number The amount to scale horizontally sy number The amount to scale vertically setScaleX(sx) Set the X scale transformation value. Parameters: Name Type Description sx The amount to scale horizontally setScaleY(sy) Set the Y scale transformation value. Parameters: Name Type Description sy The amount to scale vertically setSkew(sx, sy) Sets the skew transformation values. Parameters: Name Type Description sx The amount to skew horizontally sy The amount to skew vertically setSkewX(sx) Sets the X skew transformation value. Parameters: Name Type Description sx The amount to skew horizontally. setSkewY(sy) Sets the Y skew transformation value. Parameters: Name Type Description sy The amount to skew vertically. setTranslate(tx, ty) Sets the translate transformation values. Parameters: Name Type Description tx The amount to translate horizontally ty The amount to translate vertically setTranslateX(tx) Sets the X translate transformation value. Parameters: Name Type Description tx The amount to translate horizontally setTranslateY(ty) Set the Y translate transformation value. Parameters: Name Type Description ty The amount to translate vertically toTransform() Gets an array of values to use in an HTML Canvas context transform. Returns: Array of values Type Array.&lt;number&gt; transpose() Flips the values of the matrix using the diagonal row. × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.Math.Point.html":{"id":"Core.Math.Point.html","title":"Class: Point","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Point Core.Math. Point A utility class that represents a point with an x and y coordinate. new Point(x, y) Creates a new Point with an x and y coordinate. Parameters: Name Type Description x number The x-coordinate y number The y-coordinate Properties: Name Type Description x number The x-coordinate y number The y-coordinate Members &lt;static&gt; Origin Gets a point at (0, 0). Methods add(vec) Adds two vectors together. Parameters: Name Type Description vec Core.Math.Point A delta vector Returns: The combined vector representing a new direction Type Core.Math.Point angle(vec [, inRadians]) Gets the angle between this point and another relative to the origin. Parameters: Name Type Argument Default Description vec Core.Math.Point The other point inRadians boolean &lt;optional&gt; false Whether the result should be in radians. Default: false Returns: The angle between these two points. Returns radians if inRadians is true Type number clone() Clones this point. Returns: Returns a new instance of the same point. cross(vec) Gets the cross product of this vector and another. This operation is non-commutative. Parameters: Name Type Description vec Core.Math.Point The other vector Returns: A cross product object with X, Y, Z properties Type any distance(vec) Gets the distance between this point and another. Parameters: Name Type Description vec Core.Math.Point The other point Returns: The distance between these two points Type number dot(vec) Gets the dot product of this vector and another. This operation is commutative. Parameters: Name Type Description vec Core.Math.Point The other vector Returns: The dot product Type number equals(vec) Compares this point to another. Points are considered the same if they are within 0.00001 units of each other. Parameters: Name Type Description vec Core.Math.Point The other point Returns: Returns true if points are 0.00001 units of each other. Otherwise false. equalTo(vec) Compares this point to another. Evaluates the same way as equals. Parameters: Name Type Description vec The other point Returns: Returns true if points are 0.00001 units of each other. Otherwise false. getX() Returns the X value of this point. Returns: The X value Type number getY() Returns the Y value of this point. Returns: The Y value Type number isParallelTo(vec) Checks whether this vector is parallel to another vector. Parameters: Name Type Description vec Core.Math.Point The other vector Returns: Returns true if both vectors are parallel (same slope). Otherwise false. normalize() Normalizes the vector to get a unit vector of length 1. Returns: The unit vector Type Core.Math.Point perpendicular() Gets a perpendicular vector from this one. Returns: The perpendicular vector Type Core.Math.Point reverse() . Reverses the direction of this vector Returns: The reverse vector Type Core.Math.Point rotate(angle [, inRadians] [, withRespectTo]) Rotates this point around another point clockwise. By default, this will rotate around the origin. Parameters: Name Type Argument Default Description angle number The angle to rotate by inRadians boolean &lt;optional&gt; false Whether the amount is in radians. Default: false withRespectTo Core.Math.Point &lt;optional&gt; The point to rotate around. Default: (0, 0) rotate(s) Scales the point by a scaling factor. Parameters: Name Type Description s The amount to scale by subtract(vec) Subtracts two vectors from each other. Parameters: Name Type Description vec Core.Math.Point A delta vector Returns: The resulting vector representing a new direction Type Core.Math.Point toJSON() Serialize a Point object to a JSON object, which can be saved for further use. Calling 'JSON.stringify()' on a Point object will call this function automatically. Returns: The converted Point JSON object. toMatrix( [vecs]) Gets a matrix that represents this point. You can include additional rows to add to the final matrix. Parameters: Name Type Argument Description vecs Array.&lt;Core.Math.Point&gt; &lt;optional&gt; Additional rows to add. Returns: The matrix that represents this point. Type Core.Math.Matrix transform(transform) Applies a transformation matrix to this point. Parameters: Name Type Description transform Core.Math.Matrix The transformation matrix. translate(x, y) Translates this point by the specified delta values. Parameters: Name Type Description x number the unit in the x-axis to translate by y number the unit in the y-axis to translate by × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.Math.Quad.html":{"id":"Core.Math.Quad.html","title":"Class: Quad","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Quad Core.Math. Quad Represents a utility class used to manipulate quadrilateral objects. new Quad(x1, y1, x2, y2, x3, y3, x4, y4) Create a new Quad with the x and y coordinates of the the four points of a quadrilateral. Parameters: Name Type Description x1 number the x coordinate of the lower-left point y1 number the y coordinate of the lower-left point x2 number the x coordinate of the lower-right point y2 number the y coordinate of the lower-right point x3 number the x coordinate of the upper-right point y3 number the y coordinate of the upper-right point x4 number the x coordinate of the upper-left point y4 number the y coordinate of the upper-left point Properties: Name Type Description x1 number the x coordinate of the lower-left point y1 number the y coordinate of the lower-left point x2 number the x coordinate of the lower-right point y2 number the y coordinate of the lower-right point x3 number the x coordinate of the upper-right point y3 number the y coordinate of the upper-right point x4 number the x coordinate of the upper-left point y4 number the y coordinate of the upper-left point Example (x4,y4)---(x3,y3) | | (x1,y1)---(x2,y2) Methods toRect() Returns a Rect that represents this quad. Returns: A rect that represents this quad Type Core.Math.Rect × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.Math.Rect.html":{"id":"Core.Math.Rect.html","title":"Class: Rect","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Rect Core.Math. Rect Represents a utility class used to manipulate rectangle objects. new Rect(x1, y1, x2, y2) Create a new Rect with the x and y coordinates of the upper-left and lower right points. Parameters: Name Type Description x1 number the x coordinate of the upper-left point y1 number the y coordinate of the upper-left point x2 number the x coordinate of the lower-right point y2 number the y coordinate of the lower-right point Properties: Name Type Description x1 number the x coordinate of the upper-left point y1 number the y coordinate of the upper-left point x2 number the x coordinate of the lower-right point y2 number the y coordinate of the lower-right point Example (x1,y1)------| | | |-------(x2,y2) Methods &lt;static&gt; contains(rect, container) A static method that determines whether the first rect is contains the second rect. Parameters: Name Type Description rect Core.Math.Rect The first rect (container) container Core.Math.Rect The second rect Returns: True if the first rect contains the second rect. Otherwise false Type boolean &lt;static&gt; createFromDimensions(x, y, width, height) Creates a Rect using position and dimensions. Parameters: Name Type Description x number The X coordinate y number The Y coordinate width number The width of the rect height number The height of the rect Returns: A rect at the designated position of the defined size Type Core.Math.Rect &lt;static&gt; intersects(rect1, rect2) A static method that determines whether the two rects provided intersect each other. Parameters: Name Type Description rect1 Core.Math.Rect The first rect rect2 Core.Math.Rect The second rect Returns: True if the rects intersect. Otherwise, false. Type boolean contains(otherRect) A method to determine whether this rect contains another rect. It is not considered as containment if another rect intersects this one. Parameters: Name Type Description otherRect Rect The other rect Returns: True if this rect contains 'otherRect'. Otherwise, false. Type boolean exportNormalize() Normalizes the rect to ensure point (x1, y1) is the bottom left point as expected by xfdf output fitTo(rect) Best fit this rect into another larger rect Parameters: Name Type Description rect Core.Math.Rect getBottom() Returns the most bottom Y value. Returns: Type number getBottomLeft() Gets a Point that is at the bottom-left of the rect. Returns: A point at the bottom-left of the rect Type Core.Math.Point getBottomRight() Gets a Point that is at the top-right of the rect. Returns: A point at the top-right of the rect Type Core.Math.Point getCenter() Gets a Point that is at the center of the rect. Returns: A point at the center of the rect Type Core.Math.Point getHeight() Gets the height of the rect Returns: The height of the rect Type number getLeft() Returns the most left X value. Returns: Type number getRight() Returns the most right X value. Returns: Type number getTop() Returns the most top Y value. Returns: Type number getTopLeft() Gets a Point that is at the top-left of the rect. Returns: A point at the top-left of the rect Type Core.Math.Point getTopRight() Gets a Point that is at the top-right of the rect. Returns: A point at the top-right of the rect Type Core.Math.Point getWidth() Gets the width of the rect Returns: The width of the rect Type number intersects(otherRect) A method to determine whether this rect overlaps with another. If this rect contains another, this is still considered true. Parameters: Name Type Description otherRect Rect The other rect Returns: True if the rects intersect. Otherwise, false. Type boolean normalize() Normalizes the rect to ensure point (x1, y1) is the upper left point and width and height are non-negative. toQuad() Returns a Quad that represents this rect. Returns: A quad that represents this rect Type Core.Math.Quad transform(transform) Applies a transformation matrix to the rect which will adjust the points. Parameters: Name Type Description transform Core.Math.Matrix The transformation matrix to apply translate(x, y) Translates the rect Parameters: Name Type Description x number The amount to translate in the x direction y number The amount to translate in the y direction × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.Math.TransformationBuilder.html":{"id":"Core.Math.TransformationBuilder.html","title":"Class: TransformationBuilder","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TransformationBuilder Core.Math. TransformationBuilder A utility class to help create transformations. new TransformationBuilder( [initial]) A builder class to help facilitate creating transformation matrices. Parameters: Name Type Argument Description initial Array.&lt;Core.Math.Matrix&gt; &lt;optional&gt; transformation matrix list. Methods clear() Clears the list of all transformations. Returns: The tranformation matrix Type Core.Math.Matrix getAt(index) Gets the transformation at a particular index. Parameters: Name Type Description index number A valid index Returns: A transformation matrix Type Core.Math.Matrix getFinalTransform() Gets the final transformation by multiplying the matrices in the list. Returns: The tranformation matrix Type Core.Math.Matrix insertAt(index, transform) Inserts a transformation matrix at a particular index. Parameters: Name Type Description index number A valid index transform Core.Math.Matrix A transformation matrix Returns: This instance Type Core.Math.TransformationBuilder pop() Pop and returns the last transformation matrix. Returns: This instance Type Core.Math.TransformationBuilder push(transform) Pushes a transformation matrix into the list. Parameters: Name Type Description transform Core.Math.Matrix The transformation matrix Returns: This instance Type Core.Math.TransformationBuilder removeAt(index) Removes the transformation matrix at a particular index. Parameters: Name Type Description index number A valid index Returns: This instance Type Core.Math.TransformationBuilder rotate(angle [, inRadians]) Creates a rotation transform and adds it to the list. Parameters: Name Type Argument Default Description angle number The amount to rotate by inRadians boolean &lt;optional&gt; false Whether the amount is in radians. Default: false Returns: This instance Type Core.Math.TransformationBuilder scale(x, y) Creates a scale transform and adds it to the list. Parameters: Name Type Description x number The amount to scale by horizontally y number The amount to scale by vertically Returns: This instance Type Core.Math.TransformationBuilder setAt(index, transform) Sets the transformation matrix at a particular index. Parameters: Name Type Description index number A valid index transform Core.Math.Matrix A transformation matrix Returns: This instance Type Core.Math.TransformationBuilder skew(x, y) Creates a scale transform and adds it to the list. Parameters: Name Type Description x number The amount to scale by horizontally y number The amount to scale by vertically Returns: This instance Type Core.Math.TransformationBuilder translate(x, y) Creates a translation transform and adds it to the list. Parameters: Name Type Description x number The amount to translate by horizontally y number The amount to translate by vertically Returns: This instance Type Core.Math.TransformationBuilder translateTo(sx, sy, dx, dy) Creates a translation transform from a source to a destination and adds it to the list. Parameters: Name Type Description sx number The source X value sy number The source Y value dx number The destination X value dy number The destination Y value Returns: This instance Type Core.Math.TransformationBuilder × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:46-07:00 using the DocStrap template. "},"Core.MeasurementManager.html":{"id":"Core.MeasurementManager.html","title":"Class: MeasurementManager","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: MeasurementManager Core. MeasurementManager A manager class that controls measurement of annotations and distance create tools. new MeasurementManager() Extends Core.EventHandler Members &lt;static&gt; Events Properties: Name Type Description SCALE_UPDATED string Core.MeasurementManager.scaleUpdated Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); createAndApplyScale(options) Parameters: Name Type Description options object The options for the scale to be created Properties Name Type Description scale Core.Scale The scale object which contains the page scale, world scale and precision applyTo Array.&lt;(Core.Annotations.Annotation|Core.Tools.Tool)&gt; The measurement annotations and tools that the scale should be applied to deleteScale(scale) Parameters: Name Type Description scale Core.Scale The scale object that should be deleted disableAnnotationAndToolStyleSyncing() Disable the automatic updating of annotation styles even if the corresponding measurement tool's styles are updated. Example WebViewer(...) .then(function(instance) { let measurementManager = instance.Core.documentViewer.getMeasurementManager(); measurementManager.disableAnnotationAndToolStyleSyncing() }); enableAnnotationAndToolStyleSyncing() Enable annotation's styles to be updated when the corresponding measurement tool's styles are updated. Example WebViewer(...) .then(function(instance) { let measurementManager = instance.Core.documentViewer.getMeasurementManager(); measurementManager.enableAnnotationAndToolStyleSyncing() }); getScales() Returns: Returns an object with the keys as scale strings and the values as an array of annotations and tools that use the scale Type Object.&lt;string, Array.&lt;(Core.Annotations.Annotation|Core.Tools.Tool)&gt;&gt; isAnnotationAndToolStyleSyncingEnabled() Return true if automatic updating of annotation styles when corresponding measurement tool's styles are updated, otherwise return false. Returns: Type boolean Example WebViewer(...) .then(function(instance) { let measurementManager = instance.Core.documentViewer.getMeasurementManager(); measurementManager.isAnnotationAndToolStyleSyncingEnabled() }); off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); replaceScale(oldScale, newScale) For all annotations and tools that currently use the old scale, this scale will be replaced with the new scale. Parameters: Name Type Description oldScale Core.Scale The old scale which is selected newScale Core.Scale The new scale used to replace the old scale. Returns: Returns a list of annotations or measurement tools related to the newly created scale Type Array.&lt;(Core.Annotations.Annotation|Core.Tools.Tool)&gt; replaceScales(oldScales, newScale) For all annotations and tools that currently use the old scales, these scales will be replaced with the new scale. Parameters: Name Type Description oldScales Array.&lt;Core.Scale&gt; The array of old scales which are selected newScale Core.Scale The new scale used to replace the old scales. Returns: Returns a list of annotations or measurement tools related to the newly created scale Type Array.&lt;(Core.Annotations.Annotation|Core.Tools.Tool)&gt; trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events scaleUpdated Triggered when the scale has been updated. Parameters: Name Type Description result object All the scales with related annotations × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.PartRetrievers.html":{"id":"Core.PartRetrievers.html","title":"Namespace: PartRetrievers","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: PartRetrievers Core. PartRetrievers The namespace for anything to do with Part Retrievers Classes PartRetriever Members &lt;static&gt; CacheHinting The type of hint to provide to browsers for caching the document. The part retriever may use query parameters to influence browser caching behavior. Type: string Example NEVER_CACHE: A unique ID is appended to the document URL. CACHE: The range of bytes requested is appended to the document URL. This should be used in most cases. NO_HINT: Nothing is appended to the document URL. Useful if you require that the document URL never changes. &lt;static&gt; Types An object containing all the possible types of part retrievers. Use in conjunction with getPartRetriever Type: string Properties: Name Type Description AndroidContentPartRetriever string ArrayBufferPdfPartRetriever string AzurePartRetriever string ExternalPdfPartRetriever string HttpPartRetriever string IOSPartRetriever string LocalPartRetriever string LocalPdfPartRetriever string StreamingPartRetriever string WinRTPartRetriever string WebViewerServerPartRetriever string WebDBPartRetriever string Example const partRetriever = await getPartRetriever(PartRetrievers.Types.LocalPdfPartRetriever, file, options); Methods &lt;static&gt; getPartRetriever(type, file [, options]) Parameters: Name Type Argument Description type Core.PartRetrievers.Types The type of retriever you want to use. file File | Blob | string | ArrayBuffer The file to open with the part retriever options Object &lt;optional&gt; Options to pass to the selected part retriever Properties Name Type Argument Description decrypt function &lt;optional&gt; Function to be called to decrypt a part of the file decryptOptions function &lt;optional&gt; An object with options for the decryption e.g. {p: \"pass\", type: \"aes\"} where is p is the password cacheHint Core.PartRetrievers.CacheHinting &lt;optional&gt; The type of cache hinting to use useDownloader boolean &lt;optional&gt; Whether to use Downloader, defaults to false. filename string &lt;optional&gt; A filename that is only useful when the type is ExternalPdfPartRetriever. Use this option when the filename can't be determined from file(the second argument). withCredentials boolean &lt;optional&gt; Whether to set the withCredentials property on the XMLHttpRequest serverOptions Object &lt;optional&gt; Options to pass to the server. e.g {serverRoot: \"http://your-server-domain.com\"} Returns: Type Promise.&lt;Core.PartRetrievers.PartRetriever&gt; × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.PartRetrievers.PartRetriever.html":{"id":"Core.PartRetrievers.PartRetriever.html","title":"Class: PartRetriever","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: PartRetriever Core.PartRetrievers. PartRetriever new PartRetriever() The base class for PartRetrievers Methods setCustomHeaders(headers) Sets custom HTTP headers that will be sent with XOD part requests. Parameters: Name Type Description headers object An object with the properties and values being the header names and values that will be set. e.g. { 'MyCustomHeader': 'MyCustomValue'} setErrorCallback(callback) Sets a function to be called if there is an error loading the document or retrieving a part. Parameters: Name Type Description callback function The callback to handle the error setWithCredentials(withCredentials) Sets withCredentials on xhr requests for the document. Parameters: Name Type Description withCredentials boolean × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Scale.html":{"id":"Core.Scale.html","title":"Class: Scale","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Scale Core. Scale A class that encapsulates measurement scale information for converting from and to different units. new Scale(scaleRatio [, precision]) Parameters: Name Type Argument Description scaleRatio object | string | Array.&lt;Array.&lt;(number|string)&gt;&gt; Either an object, string or array containing the scale information. See examples for more detail. scaleObject.pageScale object &lt;optional&gt; The page scale of the document Properties Name Type Description value number The number value of the page scale unit string The unit of the page scale, e.g. cm scaleObject.worldScale object &lt;optional&gt; The world scale Properties Name Type Description value number The number value of the world scale unit string The unit of the world scale, e.g. cm precision number &lt;optional&gt; The precision of the scale Example const scale1 = new Core.Scale({pageScale: {value: 1, unit: 'in'}, worldScale: {value: 1, unit: 'ft'}}, 0.01); const scale2 = new Core.Scale([[1, 'in'], [1, 'ft']], 0.01); const scale2 = new Core.Scale('1 in = 1 ft', 0.01); const scale2 = new Core.Scale({pageScale: {value: 1, unit: 'in'}, worldScale: {value: 1, unit: 'ft'}}); Methods getScaleRatioAsArray() Returns: Returns the values and units of the page scale and world scale in an array. For example: [[1, 'in'],[1, 'in']]. Type Array.&lt;Array.&lt;(number|string)&gt;&gt; toString() Returns: Returns string format of scale Type string × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Search.html":{"id":"Core.Search.html","title":"Namespace: Search","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: Search Core. Search The namespace containing constants for search related APIs. Members &lt;static&gt; Mode Search modes that control how searching is conducted. Properties: Name Type Description CASE_SENSITIVE number If set, the found text must match the case of the search term. WHOLE_WORD number If set, the found text must be a whole word (preceeded and followed by a non-alphabetical character, or in the case of a number, a non-numerical character. REGEX number If set, the search term will be treated as a regular expression and the results will be text in the document matching that regular expression. SEARCH_UP number If set, the document pages will be searched in descending order, from bottom to top. PAGE_STOP number If set, the search will return with a result code of Page at the end of every page. Useful for updating the UI. HIGHLIGHT number If set, the bounding box the found term will be included. Useful for highlighting text and positioning the page. AMBIENT_STRING number If set, the characters surrounding the found term will be included. This gives context to the search result may be useful when providing a list of search results. WILD_CARD number If set, you can use the wildcard character (*) as part of the pattern. &lt;static&gt; ResultCode Search result code that indicates the search status. Properties: Name Type Description DONE number Search has been completed PAGE number Search on a page has been completed FOUND number A search result has been found × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.html":{"id":"Core.Tools.html","title":"Namespace: Tools","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: Tools Core. Tools Contains tools for pan scrolling, text selection, annotation editing and annotation creation. You can access it as follows: Example WebViewer(...) .then(function(instance) { const Tools = instance.Core.Tools; // Tools.SomeClass }); Classes AnnotationEditTool AnnotationSelectTool ArcCreateTool ArcMeasurementCreateTool AreaMeasurementCreateTool ArrowCreateTool CalloutCreateTool ChangeViewCreateTool CheckBoxFormFieldCreateTool CloudyRectangularAreaMeasurementTool ComboBoxFormFieldCreateTool ContentEditTool CountMeasurementCreateTool DateFreeTextCreateTool DistanceMeasurementCreateTool EllipseCreateTool EllipseMeasurementCreateTool EraserTool FileAttachmentCreateTool FreeHandCreateTool FreeHandHighlightCreateTool FreeTextCreateTool GenericAnnotationCreateTool LineCreateTool ListBoxFormFieldCreateTool MarqueeZoomTool PageCoordinate PanTool PerimeterMeasurementCreateTool PolygonCloudCreateTool PolygonCreateTool PolylineCreateTool RadioButtonFormFieldCreateTool RectangleCreateTool RectangularAreaMeasurementTool RedactionCreateTool RubberStampCreateTool SignatureCreateTool StampCreateTool StickyCreateTool TextAnnotationCreateTool TextFormFieldCreateTool TextHighlightCreateTool TextSelectTool TextSquigglyCreateTool TextStrikeoutCreateTool TextTool TextUnderlineCreateTool Tool Members &lt;static&gt; SnapModes Enum for snap mode name and values. Snap modes control which point within the page is considered as the queried point. Type: number Properties: Name Type Description DEFAULT number POINT_ON_LINE number LINE_MID_POINT number LINE_INTERSECTION number PATH_ENDPOINT number &lt;static&gt; ToolNames Represents the names for the built-in tools Type: string Properties: Name Type Description ARROW string name of the arrow line tool ARROW2 string name of the second arrow line tool ARROW3 string name of the third arrow line tool ARROW4 string name of the fourth arrow line tool CALLOUT string name of the callout tool CALLOUT2 string name of the second callout tool CALLOUT3 string name of the third callout tool CALLOUT4 string name of the fourth callout tool ELLIPSE string name of the ellipse tool ELLIPSE2 string name of the second ellipse tool ELLIPSE3 string name of the third ellipse tool ELLIPSE4 string name of the fourth ellipse tool FREEHAND string name of the freehand tool FREEHAND2 string name of the second freehand tool FREEHAND3 string name of the third freehand tool FREEHAND4 string name of the fourth freehand tool FREEHAND_HIGHLIGHT string name of the freehand highlight tool FREEHAND_HIGHLIGHT2 string name of the second freehand highlight tool FREEHAND_HIGHLIGHT3 string name of the third freehand highlight tool FREEHAND_HIGHLIGHT4 string name of the fourth freehand highlight tool FREETEXT string name of the freetext tool FREETEXT2 string name of the second freetext tool FREETEXT3 string name of the third freetext tool FREETEXT4 string name of the fourth freetext tool FORM_FILL_CROSS string name of the cross stamp tool FORM_FILL_CHECKMARK string name of the check stamp tool FORM_FILL_DOT string name of the dot stamp tool LINE string name of the line tool LINE2 string name of the second line tool LINE3 string name of the third line tool LINE4 string name of the fourth line tool POLYGON string name of the polygon tool POLYGON2 string name of the second polygon tool POLYGON3 string name of the third polygon tool POLYGON4 string name of the fourth polygon tool POLYGON_CLOUD string name of the polygon cloud tool POLYGON_CLOUD2 string name of the second polygon cloud tool POLYGON_CLOUD3 string name of the third polygon cloud tool POLYGON_CLOUD4 string name of the fourth polygon cloud tool POLYLINE string name of the polyline tool POLYLINE2 string name of the second polyline tool POLYLINE3 string name of the third polyline tool POLYLINE4 string name of the fourth polyline tool RECTANGLE string name of the rectangle tool RECTANGLE2 string name of the second rectangle tool RECTANGLE3 string name of the third rectangle tool RECTANGLE4 string name of the fourth rectangle tool DISTANCE_MEASUREMENT string name of the distance measurement tool DISTANCE_MEASUREMENT2 string name of the second distance measurement tool DISTANCE_MEASUREMENT3 string name of the third distance measurement tool DISTANCE_MEASUREMENT4 string name of the fourth distance measurement tool PERIMETER_MEASUREMENT string name of the perimeter measurement tool PERIMETER_MEASUREMENT2 string name of the second perimeter measurement tool PERIMETER_MEASUREMENT3 string name of the third perimeter measurement tool PERIMETER_MEASUREMENT4 string name of the fourth perimeter measurement tool AREA_MEASUREMENT string name of the area measurement tool AREA_MEASUREMENT2 string name of the second area measurement tool AREA_MEASUREMENT3 string name of the third area measurement tool AREA_MEASUREMENT4 string name of the fourth area measurement tool CLOUDY_RECTANGULAR_AREA_MEASUREMENT string name of the cloudy area measurement tool CLOUDY_RECTANGULAR_AREA_MEASUREMENT2 string name of the second cloudy area measurement tool CLOUDY_RECTANGULAR_AREA_MEASUREMENT3 string name of the third cloudy area measurement tool CLOUDY_RECTANGULAR_AREA_MEASUREMENT4 string name of the fourth cloudy area measurement tool COUNT_MEASUREMENT string name of the count measurement tool COUNT_MEASUREMENT2 string name of the second count measurement tool COUNT_MEASUREMENT3 string name of the third count measurement tool COUNT_MEASUREMENT4 string name of the fourth count measurement tool SIGNATURE string name of the signature tool STAMP string name of the stamp tool FILEATTACHMENT string name of the file attachment tool STICKY string name of the sticky note tool STICKY2 string name of the second sticky note tool STICKY3 string name of the third sticky note tool STICKY4 string name of the fourth sticky note tool HIGHLIGHT string name of the text highlight tool HIGHLIGHT2 string name of the second text highlight tool HIGHLIGHT3 string name of the third text highlight tool HIGHLIGHT4 string name of the fourth text highlight tool SQUIGGLY string name of the text squiggly tool SQUIGGLY2 string name of the second text squiggly tool SQUIGGLY3 string name of the third text squiggly tool SQUIGGLY4 string name of the fourth text squiggly tool STRIKEOUT string name of the text strikeout tool STRIKEOUT2 string name of the second text strikeout tool STRIKEOUT3 string name of the third text strikeout tool STRIKEOUT4 string name of the fourth text strikeout tool UNDERLINE string name of the text underline tool UNDERLINE2 string name of the second text underline tool UNDERLINE3 string name of the third text underline tool UNDERLINE4 string name of the fourth text underline tool REDACTION string Name of the text redaction tool REDACTION2 string Name of the second text redaction tool REDACTION3 string Name of the third text redaction tool REDACTION4 string Name of the fourth text redaction tool TEXT_SELECT string name of the text select tool EDIT string name of the edit(select) tool PAN string name of the pan tool CROP string name of the page crop tool MARQUEE string name of the marquee zoom tool ERASER string name of the eraser tool CONTENT_EDIT string name of the content edit tool TEXT_FORM_FIELD string name of the Text Form Field creation tool TEXT_FORM_FIELD2 string name of the second Text Form Field creation tool TEXT_FORM_FIELD3 string name of the third Text Form Field creation tool TEXT_FORM_FIELD4 string name of the fourth Text Form Field creation tool SIG_FORM_FIELD string name of the Signature Form Field creation tool SIG_FORM_FIELD2 string name of the second Signature Form Field creation tool SIG_FORM_FIELD3 string name of the third Signature Form Field creation tool SIG_FORM_FIELD4 string name of the fourth Signature Form Field creation tool CHECK_BOX_FIELD string name of the Check Box Form Field creation tool RADIO_FORM_FIELD string name of the Radio Button Form Field creation tool LIST_BOX_FIELD string name of the List Box Form Field creation tool LIST_BOX_FIELD2 string name of the second List Box Form Field creation tool LIST_BOX_FIELD3 string name of the third List Box Form Field creation tool LIST_BOX_FIELD4 string name of the fourth List Box Form Field creation tool COMBO_BOX_FIELD string name of the Combo Box Form Field creation tool COMBO_BOX_FIELD2 string name of the second Combo Box Form Field creation tool COMBO_BOX_FIELD3 string name of the third Combo Box Form Field creation tool COMBO_BOX_FIELD4 string name of the fourth Combo Box Form Field creation tool × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.AnnotationEditTool.html":{"id":"Core.Tools.AnnotationEditTool.html","title":"Class: AnnotationEditTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: AnnotationEditTool Core.Tools. AnnotationEditTool Represents a tool for DocumentViewer's built-in annotation editing. new AnnotationEditTool(docViewer) Creates a new instance of AnnotationEditTool. Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.AnnotationSelectTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.AnnotationSelectTool.html":{"id":"Core.Tools.AnnotationSelectTool.html","title":"Class: AnnotationSelectTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: AnnotationSelectTool Core.Tools. AnnotationSelectTool Represents a tool that can select annotations new AnnotationSelectTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Properties: Name Type Description overrideSelection boolean Whether to override the default annotation selection behavior of the tool. If true then annotations will not be selected by the tool. Extends Core.Tools.Tool Members &lt;static&gt; PAGE_PADDING padding at the page edges that defines how close annotations can be created and dragged to the edge Type: Core.Math.Rect Methods &lt;static&gt; disableDragScroll() Disable the drag annotation and scroll feature. Example instance.Core.Tools.AnnotationSelectTool.disableDragScroll() &lt;static&gt; enableDragScroll() Enable the drag annotation and scroll feature. Example instance.Core.Tools.AnnotationSelectTool.enableDragScroll() &lt;static&gt; setMaximumAnnotationSizeWhenResizing(maximumAnnotationSizeGetterFunction) Sets the maximum size of annotations when resizing. Parameters: Name Type Description maximumAnnotationSizeGetterFunction function A function that receives the annotation being resized and returns an object with width and height values that represent the maximum width and height the annotation should be allowed to resize to. Example instance.Core.Tools.AnnotationSelectTool.setMaximumAnnotationSizeWhenResizing((annotation) =&gt; { if (annotation instanceof instance.Annotations.RectangleAnnotation) { // maximum size for rectangles return { width: 100, height: 30 }; } // no maximum size for other types return null; }); &lt;static&gt; setMinimumAnnotationSizeWhenResizing(minimumAnnotationSizeGetterFunction) Sets the minimum size of annotations when resizing. Parameters: Name Type Description minimumAnnotationSizeGetterFunction function A function that receives the annotation being resized and returns an object with width and height values that represent the minimum width and height the annotation should be allowed to resize to. Example instance.Core.Tools.AnnotationSelectTool.setMinimumAnnotationSizeWhenResizing((annotation) =&gt; { if (annotation instanceof instance.Annotations.RectangleAnnotation) { // minimum size for rectangles return { width: 100, height: 30 }; } // no minimum size for other types return null; }); addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.ArcCreateTool.html":{"id":"Core.Tools.ArcCreateTool.html","title":"Class: ArcCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: ArcCreateTool Core.Tools. ArcCreateTool Represents the tool for creating Core.Annotations.ArcAnnotation. new ArcCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.PolylineCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.PolylineCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.PolylineCreateTool#contextMenu disableCreationOverAnnotation() Prevent the tool from creating new annotations when hovering over an existing annotation. The annotation will be selected instead. Inherited From: Core.Tools.PolylineCreateTool#disableCreationOverAnnotation Overrides: Core.Tools.PolylineCreateTool#disableCreationOverAnnotation disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolylineCreateTool#disableImmediateActionOnAnnotationSelection enableCreationOverAnnotation() Allow the tool to create new annotations when hovering over an existing annotation Inherited From: Core.Tools.PolylineCreateTool#enableCreationOverAnnotation Overrides: Core.Tools.PolylineCreateTool#enableCreationOverAnnotation enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolylineCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.PolylineCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.PolylineCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode(mode) Get the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Overrides: Core.Tools.PolylineCreateTool#getSnapMode See: Core.Tools.SnapModes keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.PolylineCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.PolylineCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Overrides: Core.Tools.PolylineCreateTool#mouseLeftDown Returns: A promise that resolves when the method execution is finished Type Promise.&lt;void&gt; mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.PolylineCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Overrides: Core.Tools.PolylineCreateTool#mouseMove Returns: A promise that resolves when the method execution is finished Type Promise.&lt;void&gt; mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.PolylineCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.PolylineCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.PolylineCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.PolylineCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.PolylineCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setAllowCreationOverAnnotation(val) Sets whether new annotations can be created by the tool when hovering over an existing annotation Parameters: Name Type Description val boolean Whether creation of annotation is allowed when hovering over another annotation Inherited From: Core.Tools.PolylineCreateTool#setAllowCreationOverAnnotation Overrides: Core.Tools.PolylineCreateTool#setAllowCreationOverAnnotation Deprecated: since version 8.0 Please use enableCreationOverAnnotation or disableCreationOverAnnotation instead setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolylineCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.PolylineCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Overrides: Core.Tools.PolylineCreateTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.PolylineCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.PolylineCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.PolylineCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.PolylineCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolylineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolylineCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.ArcMeasurementCreateTool.html":{"id":"Core.Tools.ArcMeasurementCreateTool.html","title":"Class: ArcMeasurementCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: ArcMeasurementCreateTool Core.Tools. ArcMeasurementCreateTool Represents the tool for creating arc annotations with a measure dictionary. new ArcMeasurementCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.ArcCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.ArcCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.ArcCreateTool#contextMenu disableCreationOverAnnotation() Prevent the tool from creating new annotations when hovering over an existing annotation. The annotation will be selected instead. Inherited From: Core.Tools.PolylineCreateTool#disableCreationOverAnnotation Overrides: Core.Tools.ArcCreateTool#disableCreationOverAnnotation disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.ArcCreateTool#disableImmediateActionOnAnnotationSelection enableCreationOverAnnotation() Allow the tool to create new annotations when hovering over an existing annotation Inherited From: Core.Tools.PolylineCreateTool#enableCreationOverAnnotation Overrides: Core.Tools.ArcCreateTool#enableCreationOverAnnotation enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.ArcCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.ArcCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.ArcCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode(mode) Get the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.ArcCreateTool#getSnapMode Overrides: Core.Tools.ArcCreateTool#getSnapMode See: Core.Tools.SnapModes keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.ArcCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.ArcCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.ArcCreateTool#mouseLeftDown Overrides: Core.Tools.ArcCreateTool#mouseLeftDown Returns: A promise that resolves when the method execution is finished Type Promise.&lt;void&gt; mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.ArcCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.ArcCreateTool#mouseMove Overrides: Core.Tools.ArcCreateTool#mouseMove Returns: A promise that resolves when the method execution is finished Type Promise.&lt;void&gt; mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.ArcCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.ArcCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.ArcCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.ArcCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.ArcCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setAllowCreationOverAnnotation(val) Sets whether new annotations can be created by the tool when hovering over an existing annotation Parameters: Name Type Description val boolean Whether creation of annotation is allowed when hovering over another annotation Inherited From: Core.Tools.PolylineCreateTool#setAllowCreationOverAnnotation Overrides: Core.Tools.ArcCreateTool#setAllowCreationOverAnnotation Deprecated: since version 8.0 Please use enableCreationOverAnnotation or disableCreationOverAnnotation instead setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.ArcCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.ArcCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.ArcCreateTool#setSnapMode Overrides: Core.Tools.ArcCreateTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.ArcCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.ArcCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.ArcCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.ArcCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.ArcCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.ArcCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.AreaMeasurementCreateTool.html":{"id":"Core.Tools.AreaMeasurementCreateTool.html","title":"Class: AreaMeasurementCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: AreaMeasurementCreateTool Core.Tools. AreaMeasurementCreateTool Represents the tool for creating polygon annotations with a measure dictionary. new AreaMeasurementCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.PerimeterMeasurementCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.PerimeterMeasurementCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.PerimeterMeasurementCreateTool#contextMenu disableCreationOverAnnotation() Prevent the tool from creating new annotations when hovering over an existing annotation. The annotation will be selected instead. Inherited From: Core.Tools.PolylineCreateTool#disableCreationOverAnnotation Overrides: Core.Tools.PerimeterMeasurementCreateTool#disableCreationOverAnnotation disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PerimeterMeasurementCreateTool#disableImmediateActionOnAnnotationSelection enableCreationOverAnnotation() Allow the tool to create new annotations when hovering over an existing annotation Inherited From: Core.Tools.PolylineCreateTool#enableCreationOverAnnotation Overrides: Core.Tools.PerimeterMeasurementCreateTool#enableCreationOverAnnotation enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PerimeterMeasurementCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDefaultMeasurementCaptionOptions() Gets the measurement create tool's default caption options. Returns: The measurement caption options. Type Core.Annotations.measurementCaptionOptions getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.PerimeterMeasurementCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.PerimeterMeasurementCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode() Get the current snap mode that will be used to calculate the end point position Inherited From: Core.Tools.PolylineCreateTool#getSnapMode Overrides: Core.Tools.PerimeterMeasurementCreateTool#getSnapMode See: Core.Tools.SnapModes Returns: Enum for a snapping mode for the snapping. Type number keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.PerimeterMeasurementCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.PerimeterMeasurementCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.PerimeterMeasurementCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.PerimeterMeasurementCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.PolylineCreateTool#mouseMove Overrides: Core.Tools.PerimeterMeasurementCreateTool#mouseMove Returns: A promise that resolves when the method execution is finished Type Promise.&lt;void&gt; mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.PerimeterMeasurementCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.PerimeterMeasurementCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.PerimeterMeasurementCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.PerimeterMeasurementCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.PerimeterMeasurementCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setAllowCreationOverAnnotation(val) Sets whether new annotations can be created by the tool when hovering over an existing annotation Parameters: Name Type Description val boolean Whether creation of annotation is allowed when hovering over another annotation Inherited From: Core.Tools.PolylineCreateTool#setAllowCreationOverAnnotation Overrides: Core.Tools.PerimeterMeasurementCreateTool#setAllowCreationOverAnnotation Deprecated: since version 8.0 Please use enableCreationOverAnnotation or disableCreationOverAnnotation instead setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PerimeterMeasurementCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.PerimeterMeasurementCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.PolylineCreateTool#setSnapMode Overrides: Core.Tools.PerimeterMeasurementCreateTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.PerimeterMeasurementCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.PerimeterMeasurementCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.PerimeterMeasurementCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.PerimeterMeasurementCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PerimeterMeasurementCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PerimeterMeasurementCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.ArrowCreateTool.html":{"id":"Core.Tools.ArrowCreateTool.html","title":"Class: ArrowCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: ArrowCreateTool Core.Tools. ArrowCreateTool Represents the tool for creating line annotations with an arrow head. new ArrowCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.LineCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.LineCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.LineCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.LineCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.LineCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.LineCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getDrawMode() Gets the draw mode for the tool. Inherited From: Core.Tools.LineCreateTool#getDrawMode Overrides: Core.Tools.LineCreateTool#getDrawMode Returns: The current draw mode of the tool. Type Core.Tools.LineCreateTool.DrawModes getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.LineCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode() Get the current snap mode that will be used to calculate the end point position Inherited From: Core.Tools.LineCreateTool#getSnapMode Overrides: Core.Tools.LineCreateTool#getSnapMode See: Core.Tools.SnapModes Returns: Enum for a snapping mode for the snapping. Type number keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.LineCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.LineCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.LineCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.LineCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.LineCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.LineCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.LineCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.LineCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.LineCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.LineCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setDrawMode(drawMode) Sets the draw mode for the tool. Parameters: Name Type Description drawMode Tools.LineCreateTool.DrawModes One of the available draw modes. Inherited From: Core.Tools.LineCreateTool#setDrawMode Overrides: Core.Tools.LineCreateTool#setDrawMode setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.LineCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.LineCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.LineCreateTool#setSnapMode Overrides: Core.Tools.LineCreateTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.LineCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.LineCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.LineCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.LineCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.LineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.LineCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.CalloutCreateTool.html":{"id":"Core.Tools.CalloutCreateTool.html","title":"Class: CalloutCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: CalloutCreateTool Core.Tools. CalloutCreateTool Represents the tool for creating Core.Annotations.FreeTextAnnotation. new CalloutCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Properties: Name Type Description lineCount number The number of segments for the line of the created callout defaults object The default styles of the tool Properties Name Type Description StrokeColor Core.Annotations.Color The stroke color of the tool FillColor Core.Annotations.Color The fill color of the tool TextColor Core.Annotations.Color The text color of the tool Opacity number The opacity of the tool StrokeThickness number The stroke thickness of the tool FontSize number The font size of the tool Width number The width of the text box Height number The height of the text box Font string The font family of the tool. The value should be web safe fonts TextAlign 'left' | 'center' | 'right' The text alignment of the tool Extends Core.Tools.PolylineCreateTool Methods &lt;static&gt; setTextHandler(handler) Parameters: Name Type Description handler function A function that should return a string that will be used as the initial text for a freetext annotation addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.PolylineCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.PolylineCreateTool#contextMenu disableAutoSizedTextBox() Disables auto resizing of the annotation text box disableCreationOverAnnotation() Prevent the tool from creating new annotations when hovering over an existing annotation. The annotation will be selected instead. Inherited From: Core.Tools.PolylineCreateTool#disableCreationOverAnnotation Overrides: Core.Tools.PolylineCreateTool#disableCreationOverAnnotation disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolylineCreateTool#disableImmediateActionOnAnnotationSelection enableAutoSizedTextBox() Enables the text box of the annotation to auto resize with a fixed width when the text changes The width can be adjusted by changing calloutTool.defaults.Width to a different value enableCreationOverAnnotation() Allow the tool to create new annotations when hovering over an existing annotation Inherited From: Core.Tools.PolylineCreateTool#enableCreationOverAnnotation Overrides: Core.Tools.PolylineCreateTool#enableCreationOverAnnotation enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolylineCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.PolylineCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.PolylineCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode() Get the current snap mode that will be used to calculate the end point position Inherited From: Core.Tools.PolylineCreateTool#getSnapMode Overrides: Core.Tools.PolylineCreateTool#getSnapMode See: Core.Tools.SnapModes Returns: Enum for a snapping mode for the snapping. Type number keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.PolylineCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.PolylineCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.PolylineCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.PolylineCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.PolylineCreateTool#mouseMove Overrides: Core.Tools.PolylineCreateTool#mouseMove Returns: A promise that resolves when the method execution is finished Type Promise.&lt;void&gt; mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.PolylineCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.PolylineCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.PolylineCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.PolylineCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.PolylineCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setAllowCreationOverAnnotation(val) Sets whether new annotations can be created by the tool when hovering over an existing annotation Parameters: Name Type Description val boolean Whether creation of annotation is allowed when hovering over another annotation Inherited From: Core.Tools.PolylineCreateTool#setAllowCreationOverAnnotation Overrides: Core.Tools.PolylineCreateTool#setAllowCreationOverAnnotation Deprecated: since version 8.0 Please use enableCreationOverAnnotation or disableCreationOverAnnotation instead setEnableAutoSized(enable) Set if the text box of the annotation should auto resize with a fixed width on text change The width can be adjusted by changing calloutTool.defaults.Width to a different value Parameters: Name Type Description enable boolean A boolean indicating whether only the box height will resize on text change Deprecated: since version 8.0 Please use enableAutoSizedTextBox or disableAutoSizedTextBox instead setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolylineCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.PolylineCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.PolylineCreateTool#setSnapMode Overrides: Core.Tools.PolylineCreateTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.PolylineCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.PolylineCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.PolylineCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.PolylineCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolylineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolylineCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.ChangeViewCreateTool.html":{"id":"Core.Tools.ChangeViewCreateTool.html","title":"Class: ChangeViewCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: ChangeViewCreateTool Core.Tools. ChangeViewCreateTool Represents the tool for creating change view annotations new ChangeViewCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.Tool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.Tool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.Tool#contextMenu disableCreationOverAnnotation() Prevent the tool from creating new annotations when hovering over an existing annotation. The annotation will be selected instead. enableCreationOverAnnotation() Allow the tool to create new annotations when hovering over an existing annotation getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.Tool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.Tool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.Tool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.Tool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.Tool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.Tool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.Tool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.Tool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.CheckBoxFormFieldCreateTool.html":{"id":"Core.Tools.CheckBoxFormFieldCreateTool.html","title":"Class: CheckBoxFormFieldCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: CheckBoxFormFieldCreateTool Core.Tools. CheckBoxFormFieldCreateTool Represents the tool for creating CheckBox Form Field Placeholders. new CheckBoxFormFieldCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.RectangleCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.RectangleCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.RectangleCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangleCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangleCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.RectangleCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.RectangleCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.RectangleCreateTool#getSnapMode Overrides: Core.Tools.RectangleCreateTool#getSnapMode See: Core.Tools.SnapModes keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.RectangleCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.RectangleCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.RectangleCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.RectangleCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.RectangleCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.RectangleCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.RectangleCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.RectangleCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.RectangleCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.RectangleCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangleCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.RectangleCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.RectangleCreateTool#setSnapMode Overrides: Core.Tools.RectangleCreateTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.RectangleCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.RectangleCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.RectangleCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.RectangleCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangleCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangleCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.CloudyRectangularAreaMeasurementTool.html":{"id":"Core.Tools.CloudyRectangularAreaMeasurementTool.html","title":"Class: CloudyRectangularAreaMeasurementTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: CloudyRectangularAreaMeasurementTool Core.Tools. CloudyRectangularAreaMeasurementTool Represents the tool for creating rectangular polygon annotations with a measure dictionary. new CloudyRectangularAreaMeasurementTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.RectangularAreaMeasurementTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.RectangularAreaMeasurementTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.RectangularAreaMeasurementTool#contextMenu disableCreationOverAnnotation() Prevent the tool from creating new annotations when hovering over an existing annotation. The annotation will be selected instead. Inherited From: Core.Tools.PolylineCreateTool#disableCreationOverAnnotation Overrides: Core.Tools.RectangularAreaMeasurementTool#disableCreationOverAnnotation disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangularAreaMeasurementTool#disableImmediateActionOnAnnotationSelection enableCreationOverAnnotation() Allow the tool to create new annotations when hovering over an existing annotation Inherited From: Core.Tools.PolylineCreateTool#enableCreationOverAnnotation Overrides: Core.Tools.RectangularAreaMeasurementTool#enableCreationOverAnnotation enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangularAreaMeasurementTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDefaultMeasurementCaptionOptions() Gets the measurement create tool's default caption options. Inherited From: Core.Tools.AreaMeasurementCreateTool#getDefaultMeasurementCaptionOptions Overrides: Core.Tools.RectangularAreaMeasurementTool#getDefaultMeasurementCaptionOptions Returns: The measurement caption options. Type Core.Annotations.measurementCaptionOptions getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.RectangularAreaMeasurementTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getDrawMode() Gets the draw mode for the tool. Inherited From: Core.Tools.RectangularAreaMeasurementTool#getDrawMode Overrides: Core.Tools.RectangularAreaMeasurementTool#getDrawMode Returns: The current draw mode of the tool. Type Core.Tools.RectangularAreaMeasurementTool.DrawModes getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.RectangularAreaMeasurementTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode() Get the current snap mode that will be used to calculate the end point position Inherited From: Core.Tools.PolylineCreateTool#getSnapMode Overrides: Core.Tools.RectangularAreaMeasurementTool#getSnapMode See: Core.Tools.SnapModes Returns: Enum for a snapping mode for the snapping. Type number keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.RectangularAreaMeasurementTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.RectangularAreaMeasurementTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.RectangularAreaMeasurementTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.RectangularAreaMeasurementTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.PolylineCreateTool#mouseMove Overrides: Core.Tools.RectangularAreaMeasurementTool#mouseMove Returns: A promise that resolves when the method execution is finished Type Promise.&lt;void&gt; mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.RectangularAreaMeasurementTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.RectangularAreaMeasurementTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.RectangularAreaMeasurementTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.RectangularAreaMeasurementTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.RectangularAreaMeasurementTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setAllowCreationOverAnnotation(val) Sets whether new annotations can be created by the tool when hovering over an existing annotation Parameters: Name Type Description val boolean Whether creation of annotation is allowed when hovering over another annotation Inherited From: Core.Tools.PolylineCreateTool#setAllowCreationOverAnnotation Overrides: Core.Tools.RectangularAreaMeasurementTool#setAllowCreationOverAnnotation Deprecated: since version 8.0 Please use enableCreationOverAnnotation or disableCreationOverAnnotation instead setDrawMode(drawMode) Sets the draw mode for the tool. Parameters: Name Type Description drawMode Core.Tools.RectangularAreaMeasurementTool.DrawModes One of the available draw modes. Inherited From: Core.Tools.RectangularAreaMeasurementTool#setDrawMode Overrides: Core.Tools.RectangularAreaMeasurementTool#setDrawMode setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangularAreaMeasurementTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.RectangularAreaMeasurementTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.PolylineCreateTool#setSnapMode Overrides: Core.Tools.RectangularAreaMeasurementTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.RectangularAreaMeasurementTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.RectangularAreaMeasurementTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.RectangularAreaMeasurementTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.RectangularAreaMeasurementTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangularAreaMeasurementTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangularAreaMeasurementTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.ComboBoxFormFieldCreateTool.html":{"id":"Core.Tools.ComboBoxFormFieldCreateTool.html","title":"Class: ComboBoxFormFieldCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: ComboBoxFormFieldCreateTool Core.Tools. ComboBoxFormFieldCreateTool Represents the tool for creating ComboBox Form Field Placeholders new ComboBoxFormFieldCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.RectangleCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.RectangleCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.RectangleCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangleCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangleCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.RectangleCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.RectangleCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.RectangleCreateTool#getSnapMode Overrides: Core.Tools.RectangleCreateTool#getSnapMode See: Core.Tools.SnapModes keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.RectangleCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.RectangleCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.RectangleCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.RectangleCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.RectangleCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.RectangleCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.RectangleCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.RectangleCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.RectangleCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.RectangleCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangleCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.RectangleCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.RectangleCreateTool#setSnapMode Overrides: Core.Tools.RectangleCreateTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.RectangleCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.RectangleCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.RectangleCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.RectangleCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangleCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangleCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.ContentEditTool.html":{"id":"Core.Tools.ContentEditTool.html","title":"Class: ContentEditTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: ContentEditTool Core.Tools. ContentEditTool Represents a tool for document content editing. When this tool is active then editable content boxes will automatically show up on the pages. new ContentEditTool(docViewer, name) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. name string Name of the tool. Extends Core.Tools.AnnotationSelectTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.CountMeasurementCreateTool.html":{"id":"Core.Tools.CountMeasurementCreateTool.html","title":"Class: CountMeasurementCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: CountMeasurementCreateTool Core.Tools. CountMeasurementCreateTool Represents the tool to create count measurement annotations new CountMeasurementCreateTool(docViewer) Creates a new instance of the CountMeasurementCreateTool Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer Extends Core.Tools.StickyCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu disableCreationOverAnnotation() Prevent the tool from creating new annotations when hovering over an existing annotation. The annotation will be selected instead. Inherited From: Core.Tools.StickyCreateTool#disableCreationOverAnnotation disableViewStateSaving() When called new annotations will not have a ViewState applied to them. By default no ViewState is applied. ViewState is the state of the viewer when the annotation is created. When the annotation is double clicked and ViewState exists, the viewer state will be set to the ViewState Inherited From: Core.Tools.StickyCreateTool#disableViewStateSaving enableCreationOverAnnotation() Allow the tool to create new annotations when hovering over an existing annotation Inherited From: Core.Tools.StickyCreateTool#enableCreationOverAnnotation enableViewStateSaving() When enabled, new annotations will have a ViewState applied to them. ViewState is the state of the viewer when the annotation is created. When the annotation is double clicked and ViewState exists, the viewer state will be set to the ViewState Inherited From: Core.Tools.StickyCreateTool#enableViewStateSaving getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setAllowCreationOverAnnotation(val) Sets whether new annotations can be created by the tool when hovering over an existing annotation Parameters: Name Type Description val boolean Whether creation of annotation is allowed when hovering over another annotation Inherited From: Core.Tools.StickyCreateTool#setAllowCreationOverAnnotation Deprecated: since version 8.0 Please use enableCreationOverAnnotation or disableCreationOverAnnotation instead setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName setSaveViewState(val) Sets whether new annotations have a ViewState applied to them. ViewState is the state of the viewer when the annotation is created. When the annotation is double clicked and ViewState exists, the viewer state will be set to the ViewState Parameters: Name Type Description val boolean Inherited From: Core.Tools.StickyCreateTool#setSaveViewState Deprecated: since version 8.0 Please use enableViewStateSaving or disableViewStateSaving instead setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.StickyCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.StickyCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.DateFreeTextCreateTool.html":{"id":"Core.Tools.DateFreeTextCreateTool.html","title":"Class: DateFreeTextCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: DateFreeTextCreateTool Core.Tools. DateFreeTextCreateTool Represents the tool for creating Core.Annotations.FreeTextAnnotation with an associated date format. new DateFreeTextCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.FreeTextCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.FreeTextCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.FreeTextCreateTool#contextMenu disableAutoFocusOnCreate() Disables autofocus of free text annotations on creation. Inherited From: Core.Tools.FreeTextCreateTool#disableAutoFocusOnCreate Overrides: Core.Tools.FreeTextCreateTool#disableAutoFocusOnCreate Example const { Core } = instance; Core.documentViewer.getTool(Core.Tools.ToolNames.FREETEXT).disableAutoFocusOnCreate(); disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.FreeTextCreateTool#disableImmediateActionOnAnnotationSelection enableAutoFocusOnCreate() Enables autofocus of free text annotations on creation. Inherited From: Core.Tools.FreeTextCreateTool#enableAutoFocusOnCreate Overrides: Core.Tools.FreeTextCreateTool#enableAutoFocusOnCreate Example const { Core } = instance; Core.documentViewer.getTool(Core.Tools.ToolNames.FREETEXT).enableAutoFocusOnCreate(); enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.FreeTextCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDateFormat() Get the date format for the date picker Returns: The date format used by this tool Type string getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.FreeTextCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.FreeTextCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point isAutoFocusingOnCreate() Returns whether free text annotations autofocus on creation. Inherited From: Core.Tools.FreeTextCreateTool#isAutoFocusingOnCreate Overrides: Core.Tools.FreeTextCreateTool#isAutoFocusingOnCreate Returns: Returns true if free texts are autofocused on creation, false otherwise. Type boolean keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.FreeTextCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.FreeTextCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.FreeTextCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.FreeTextCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.FreeTextCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.FreeTextCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.FreeTextCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.FreeTextCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.FreeTextCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.FreeTextCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setDateFormat(dateFormat) Set the date format for the date picker Parameters: Name Type Description dateFormat string The date format that will be used by FreeText annotations created with this tool, eg: 'YYYY-MM-DD' setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.FreeTextCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.FreeTextCreateTool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.FreeTextCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.FreeTextCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.FreeTextCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.FreeTextCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.FreeTextCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.FreeTextCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.DistanceMeasurementCreateTool.html":{"id":"Core.Tools.DistanceMeasurementCreateTool.html","title":"Class: DistanceMeasurementCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: DistanceMeasurementCreateTool Core.Tools. DistanceMeasurementCreateTool Represents the tool for creating line annotations with a measure dictionary. new DistanceMeasurementCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.LineCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.LineCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.LineCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.LineCreateTool#disableImmediateActionOnAnnotationSelection disableImperialMarks() Disable the showing of imperial marks for the units of distance annotations created by this tool Example WebViewer(...).then(instance =&gt; { const { Core } = instance; const tool = Core.documentViewer.getTool(Core.Tools.ToolNames.DISTANCE_MEASUREMENT); tool.disableImperialMarks(); }) disableImperialMarks() Check if imperial marks is enabled or disabled Returns: Returns true if tool is imperial marks enabled Type boolean Example WebViewer(...).then(instance =&gt; { const tool = instance.Core.documentViewer.getTool('AnnotationCreateDistanceMeasurement'); tool.isImperialMarksEnabled(); }) disableLeaderLines() Disables drawing of leader lines after the first mouse up. The annotation will be immediately created. Deprecated: Since version 8.5 - Please use setLeaderLineDefaultOptions instead. enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.LineCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } enableImperialMarks() Enables the creation of new distance annotations where the units are shown as imperial marks: ' and \" Example WebViewer(...).then(instance =&gt; { const { Core } = instance; const tool = Core.documentViewer.getTool(Core.Tools.ToolNames.DISTANCE_MEASUREMENT); tool.enableImperialMarks(); }) enableLeaderLines() Enables the drawing of leader lines after the first mouse up instead of finishing the creation of the annotation Deprecated: Since version 8.5 - Please use setLeaderLineDefaultOptions instead. getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.LineCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getDrawMode() Gets the draw mode for the tool. Inherited From: Core.Tools.LineCreateTool#getDrawMode Overrides: Core.Tools.LineCreateTool#getDrawMode Returns: The current draw mode of the tool. Type Core.Tools.LineCreateTool.DrawModes getLeaderLineDefaultOptions() Gets the default options set for leader line functionality. Returns: Type Core.Tools.DistanceMeasurementCreateTool.LeaderLineOptions Example WebViewer(...).then(instance =&gt; { const { Core } = instance; const tool = Core.documentViewer.getTool(Core.Tools.ToolNames.DISTANCE_MEASUREMENT); const defaultLeaderLineOptions = tool.getLeaderLineDefaultOptions(); console.log(defaultLeaderLineOptions); }); getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.LineCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode() Get the current snap mode that will be used to calculate the end point position Inherited From: Core.Tools.LineCreateTool#getSnapMode Overrides: Core.Tools.LineCreateTool#getSnapMode See: Core.Tools.SnapModes Returns: Enum for a snapping mode for the snapping. Type number keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.LineCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.LineCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.LineCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.LineCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.LineCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.LineCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.LineCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.LineCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.LineCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.LineCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setDrawMode(drawMode) Sets the draw mode for the tool. Parameters: Name Type Description drawMode Tools.LineCreateTool.DrawModes One of the available draw modes. Inherited From: Core.Tools.LineCreateTool#setDrawMode Overrides: Core.Tools.LineCreateTool#setDrawMode setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.LineCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setEnableLeaderLines(enable) Set if the tool should draw leader lines after the first mouse up instead of finishing it Parameters: Name Type Description enable boolean A boolean indicating whether leader lines should be drawn Deprecated: Since version 8.0 - Please use setLeaderLineDefaultOptions instead. setLeaderLineDefaultOptions(options) Sets the default options set for leader lines. Parameters: Name Type Description options Core.Tools.DistanceMeasurementCreateTool.LeaderLineOptions Example WebViewer(...).then(instance =&gt; { const { Core } = instance; const tool = Core.documentViewer.getTool(Core.Tools.ToolNames.DISTANCE_MEASUREMENT); const defaultLeaderLineOptions = tool.setLeaderLineDefaultOptions({ enabled: true, autoCreate: true, length: 20 }); }); setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.LineCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.LineCreateTool#setSnapMode Overrides: Core.Tools.LineCreateTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.LineCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.LineCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.LineCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.LineCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Type Definitions LeaderLineOptions Type: Object Properties: Name Type Description enabled boolean Indicates if leader lines can be drawn after an annotation is created. autoCreate boolean Indicates if leader lines will be drawn automatically after an annotation is created. length number Indicates length of leader lines in pixels. Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.LineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.LineCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:47-07:00 using the DocStrap template. "},"Core.Tools.EllipseCreateTool.html":{"id":"Core.Tools.EllipseCreateTool.html","title":"Class: EllipseCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: EllipseCreateTool Core.Tools. EllipseCreateTool Represents the tool for creating Core.Annotations.EllipseAnnotation. new EllipseCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.GenericAnnotationCreateTool Members &lt;static&gt; DrawModes An enum representing the draw modes available for creating annotations. Type: string Properties: Name Type Description HOLD_TO_DRAW string The annotation is created by clicking and dragging TWO_CLICKS string The annotation is created by one click for the start point and a second click for the end point Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.GenericAnnotationCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.GenericAnnotationCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.GenericAnnotationCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getDrawMode() Gets the draw mode for the tool. Returns: The current draw mode of the tool. Type Core.Tools.EllipseCreateTool.DrawModes getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.GenericAnnotationCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.GenericAnnotationCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.GenericAnnotationCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.GenericAnnotationCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.GenericAnnotationCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.GenericAnnotationCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.GenericAnnotationCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.GenericAnnotationCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.GenericAnnotationCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.GenericAnnotationCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.GenericAnnotationCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setDrawMode(drawMode) Sets the draw mode for the tool. Parameters: Name Type Description drawMode Core.Tools.EllipseCreateTool.DrawModes One of the available draw modes. setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.GenericAnnotationCreateTool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.GenericAnnotationCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.GenericAnnotationCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.GenericAnnotationCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.GenericAnnotationCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:48-07:00 using the DocStrap template. "},"Core.Tools.EllipseMeasurementCreateTool.html":{"id":"Core.Tools.EllipseMeasurementCreateTool.html","title":"Class: EllipseMeasurementCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: EllipseMeasurementCreateTool Core.Tools. EllipseMeasurementCreateTool Represents the tool from creating an Ellipse Annotation to measure area and diameter new EllipseMeasurementCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer Extends Core.Tools.EllipseCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.EllipseCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.EllipseCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.EllipseCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.EllipseCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDefaultMeasurementCaptionOptions() Gets the measurement create tool's default caption options. Returns: The measurement caption options. Type Core.Annotations.measurementCaptionOptions getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.EllipseCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getDrawMode() Gets the draw mode for the tool. Inherited From: Core.Tools.EllipseCreateTool#getDrawMode Overrides: Core.Tools.EllipseCreateTool#getDrawMode Returns: The current draw mode of the tool. Type Core.Tools.EllipseCreateTool.DrawModes getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.EllipseCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.EllipseCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.EllipseCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.EllipseCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.EllipseCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.EllipseCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.EllipseCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.EllipseCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.EllipseCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.EllipseCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.EllipseCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setDefaultMeasurementCaptionOptions(options) Sets the measurement create tool's default caption options. Parameters: Name Type Description options Core.Annotations.measurementCaptionOptions The measurement caption options. setDrawMode(drawMode) Sets the draw mode for the tool. Parameters: Name Type Description drawMode Core.Tools.EllipseCreateTool.DrawModes One of the available draw modes. Inherited From: Core.Tools.EllipseCreateTool#setDrawMode Overrides: Core.Tools.EllipseCreateTool#setDrawMode setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.EllipseCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.EllipseCreateTool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.EllipseCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.EllipseCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.EllipseCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.EllipseCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.EllipseCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.EllipseCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:48-07:00 using the DocStrap template. "},"Core.Tools.EraserTool.html":{"id":"Core.Tools.EraserTool.html","title":"Class: EraserTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: EraserTool Core.Tools. EraserTool Represents the tool for creating Core.Annotations.EraserTool. new EraserTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer an instance of DocumentViewer. Extends Core.Tools.GenericAnnotationCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.GenericAnnotationCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.GenericAnnotationCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.GenericAnnotationCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.GenericAnnotationCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.GenericAnnotationCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.GenericAnnotationCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.GenericAnnotationCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.GenericAnnotationCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.GenericAnnotationCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.GenericAnnotationCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.GenericAnnotationCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.GenericAnnotationCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.GenericAnnotationCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.GenericAnnotationCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.GenericAnnotationCreateTool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.GenericAnnotationCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.GenericAnnotationCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.GenericAnnotationCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.GenericAnnotationCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated erasingAnnotation Triggered when an annotation is about to be deleted from the document by the tool Parameters: Name Type Description args object Event arguments with event related properties Properties Name Type Description annotation The annotation that will be deleted skipAnnotation Core.Annotations.FreeHandAnnotation A function you can call to skip deleting the annotation or points from a Example const eraserTool = docViewer.getTool('AnnotationEraserTool'); eraserTool.addEventListener('erasingAnnotation', function(args) { // Make eraser tool skip deleting rectangle annotations if (args.annotation instanceof Annotations.RectangleAnnotation) { args.skipAnnotation(); } }); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:48-07:00 using the DocStrap template. "},"Core.Tools.FileAttachmentCreateTool.html":{"id":"Core.Tools.FileAttachmentCreateTool.html","title":"Class: FileAttachmentCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: FileAttachmentCreateTool Core.Tools. FileAttachmentCreateTool Represents the tool for creating Core.Annotations.FileAttachmentAnnotation. new FileAttachmentCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Properties: Name Type Description ACCEPTED_FILE_TYPES string A string specifying the accepted file types to be opened by the file picker. By default any file type is accepted. ACCEPTED_FILE_SIZE number A number specifying the accepted file size in bytes (exclusive). A null, undefined, or value zero and below means no limit. Extends Core.Tools.Tool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.Tool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.Tool#contextMenu getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.Tool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.Tool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.Tool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.Tool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.Tool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.Tool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.Tool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.Tool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:48-07:00 using the DocStrap template. "},"Core.Tools.FreeHandCreateTool.html":{"id":"Core.Tools.FreeHandCreateTool.html","title":"Class: FreeHandCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: FreeHandCreateTool Core.Tools. FreeHandCreateTool Represents the tool for creating Core.Annotations.FreeHandAnnotation. new FreeHandCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Properties: Name Type Description createDelay number The delay to allow for multiple paths to be added as part of the same annotation simplifyPen boolean Whether to simplify the annotation path when a pen input is used, defaults to false Extends Core.Tools.GenericAnnotationCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.GenericAnnotationCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); complete() When called, the current freehand annotation being created is added to the AnnotationManager, ignoring the createDelay. It is only necessary to call this function if you want the annotation to be added before the createDelay elapses. Returns: A promise that resolves when the current freehand annotation has been added to the AnnotationManager Type Promise.&lt;any&gt; contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.GenericAnnotationCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getCreateDelay() Get the createDelay property of the tool. Returns: The delay to allow for multiple paths to be added as part of the same annotation Type number getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.GenericAnnotationCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.GenericAnnotationCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSimplifyPen() Get the simplifyPen property of the tool. Returns: Whether to simplify the annotation path when a pen input is used, defaults to false Type boolean keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.GenericAnnotationCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.GenericAnnotationCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.GenericAnnotationCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.GenericAnnotationCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.GenericAnnotationCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.GenericAnnotationCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.GenericAnnotationCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.GenericAnnotationCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.GenericAnnotationCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.GenericAnnotationCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setCreateDelay(createDelay) Set the createDelay property of the tool. This will change the delay for the tool to register new strokes as a new annotation. This will change the createDelay property on the instance of the tool, not the prototype. Parameters: Name Type Description createDelay number The delay to allow for multiple paths to be added as part on the same annotation setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.GenericAnnotationCreateTool#setName setSimplifyPen(simplifyPen) Set the simplifyPen property of the tool. This will change the simplifyPen property on the instance of the tool, not the prototype. Parameters: Name Type Description simplifyPen boolean Whether to simplify the annotation path when a pen input is used, defaults to false setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.GenericAnnotationCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.GenericAnnotationCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.GenericAnnotationCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.GenericAnnotationCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:48-07:00 using the DocStrap template. "},"Core.Tools.FreeHandHighlightCreateTool.html":{"id":"Core.Tools.FreeHandHighlightCreateTool.html","title":"Class: FreeHandHighlightCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: FreeHandHighlightCreateTool Core.Tools. FreeHandHighlightCreateTool Represents the tool for creating Core.Annotations.FreeHandAnnotation. new FreeHandHighlightCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Properties: Name Type Description createDelay number The delay to allow for multiple paths to be added as part of the same annotation simplifyPen boolean Whether to simplify the annotation path when a pen input is used, defaults to false autoSmoothingRange number The range for error in auto-smoothing, a larger number meaning more room for error. Highlights that are drawn wider than this range will not be autosmoothed Extends Core.Tools.FreeHandCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.FreeHandCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); complete() When called, the current freehand annotation being created is added to the AnnotationManager, ignoring the createDelay. It is only necessary to call this function if you want the annotation to be added before the createDelay elapses. Inherited From: Core.Tools.FreeHandCreateTool#complete Overrides: Core.Tools.FreeHandCreateTool#complete Returns: A promise that resolves when the current freehand annotation has been added to the AnnotationManager Type Promise.&lt;any&gt; contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.FreeHandCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.FreeHandCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.FreeHandCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getAutoSmoothingRange() Gets how wide the range would be for auto smoothing vertical and horizontal strokes. Returns: Returns a number indicating how the range would be for auto smoothing vertical and horizontal strokes. Type number Example const tool = docViewer.getTool(instance.Core.Tools.ToolNames.FREEHAND_HIGHLIGHT); tool.getAutoSmoothingRange(); getCreateDelay() Get the createDelay property of the tool. Inherited From: Core.Tools.FreeHandCreateTool#getCreateDelay Overrides: Core.Tools.FreeHandCreateTool#getCreateDelay Returns: The delay to allow for multiple paths to be added as part of the same annotation Type number getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.FreeHandCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.FreeHandCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSimplifyPen() Get the simplifyPen property of the tool. Inherited From: Core.Tools.FreeHandCreateTool#getSimplifyPen Overrides: Core.Tools.FreeHandCreateTool#getSimplifyPen Returns: Whether to simplify the annotation path when a pen input is used, defaults to false Type boolean keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.FreeHandCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.FreeHandCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.FreeHandCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.FreeHandCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.FreeHandCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.FreeHandCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.FreeHandCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.FreeHandCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.FreeHandCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.FreeHandCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setAutoSmoothingRange(range) Sets how wide the range would be for auto smoothing vertical and horizontal strokes. Parameters: Name Type Description range number a number indicating how wide is the range to auto smooth vertical and horizontal strokes Example const tool = docViewer.getTool(instance.Core.Tools.ToolNames.FREEHAND_HIGHLIGHT); tool.setAutoSmoothingRange(1); setCreateDelay(createDelay) Set the createDelay property of the tool. This will change the delay for the tool to register new strokes as a new annotation. This will change the createDelay property on the instance of the tool, not the prototype. Parameters: Name Type Description createDelay number The delay to allow for multiple paths to be added as part on the same annotation Inherited From: Core.Tools.FreeHandCreateTool#setCreateDelay Overrides: Core.Tools.FreeHandCreateTool#setCreateDelay setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.FreeHandCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.FreeHandCreateTool#setName setSimplifyPen(simplifyPen) Set the simplifyPen property of the tool. This will change the simplifyPen property on the instance of the tool, not the prototype. Parameters: Name Type Description simplifyPen boolean Whether to simplify the annotation path when a pen input is used, defaults to false Inherited From: Core.Tools.FreeHandCreateTool#setSimplifyPen Overrides: Core.Tools.FreeHandCreateTool#setSimplifyPen setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.FreeHandCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.FreeHandCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.FreeHandCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.FreeHandCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.FreeHandCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.FreeHandCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:48-07:00 using the DocStrap template. "},"Core.Tools.FreeTextCreateTool.html":{"id":"Core.Tools.FreeTextCreateTool.html","title":"Class: FreeTextCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: FreeTextCreateTool Core.Tools. FreeTextCreateTool Represents the tool for creating Core.Annotations.FreeTextAnnotation. new FreeTextCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Properties: Name Type Description defaults object The default styles of the tool Properties Name Type Description StrokeColor Core.Annotations.Color The stroke color of the tool FillColor Core.Annotations.Color The fill color of the tool TextColor Core.Annotations.Color The text color of the tool Opacity number The opacity of the tool StrokeThickness number The stroke thickness of the tool FontSize number The font size of the tool Font string The font family of the tool. The value should be web safe fonts TextAlign 'left' | 'center' | 'right' The horizontal text alignment of the tool TextVerticalAlign 'top' | 'center' | 'bottom' The vertical text alignment of the tool RichTextStyle Core.Annotations.Annotation.RichTextCSSStyle The RichTextCSSStyle for text created by the tool Extends Core.Tools.GenericAnnotationCreateTool Methods &lt;static&gt; setTextHandler(handler) Parameters: Name Type Description handler function A function that should return a string that will be used as the initial text for a freetext annotation addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.GenericAnnotationCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.GenericAnnotationCreateTool#contextMenu disableAutoFocusOnCreate() Disables autofocus of free text annotations on creation. Example const { Core } = instance; Core.documentViewer.getTool(Core.Tools.ToolNames.FREETEXT).disableAutoFocusOnCreate(); disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#disableImmediateActionOnAnnotationSelection enableAutoFocusOnCreate() Enables autofocus of free text annotations on creation. Example const { Core } = instance; Core.documentViewer.getTool(Core.Tools.ToolNames.FREETEXT).enableAutoFocusOnCreate(); enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.GenericAnnotationCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.GenericAnnotationCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point isAutoFocusingOnCreate() Returns whether free text annotations autofocus on creation. Returns: Returns true if free texts are autofocused on creation, false otherwise. Type boolean keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.GenericAnnotationCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.GenericAnnotationCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.GenericAnnotationCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.GenericAnnotationCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.GenericAnnotationCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.GenericAnnotationCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.GenericAnnotationCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.GenericAnnotationCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.GenericAnnotationCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.GenericAnnotationCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.GenericAnnotationCreateTool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.GenericAnnotationCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.GenericAnnotationCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.GenericAnnotationCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.GenericAnnotationCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:48-07:00 using the DocStrap template. "},"Core.Tools.GenericAnnotationCreateTool.html":{"id":"Core.Tools.GenericAnnotationCreateTool.html","title":"Class: GenericAnnotationCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: GenericAnnotationCreateTool Core.Tools. GenericAnnotationCreateTool Represents a generic tool use to create markup annotations based on two mouse points (mouse left down and mouse left up). new GenericAnnotationCreateTool(docViewer, annotationPrototype [, constructorArg]) Parameters: Name Type Argument Description docViewer Core.DocumentViewer The instance of the corresponding DocumentViewer annotationPrototype Core.Annotations.Annotation The prototype of the Annotation to create. constructorArg object &lt;optional&gt; optional argument to pass to the annotation's constructor Properties: Name Type Description annotation Core.Annotations.Annotation The instance of the annotation object created annotationPrototype Core.Annotations.Annotation The prototype of the annotation object created defaults Object The default styles of the tool Properties Name Type Description StrokeColor Core.Annotations.Color The stroke color of the tool FillColor Core.Annotations.Color The fill color of the tool Opacity number The opacity of the tool StrokeThickness number The stroke thickness of the tool Extends Core.Tools.AnnotationSelectTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:48-07:00 using the DocStrap template. "},"Core.Tools.LineCreateTool.html":{"id":"Core.Tools.LineCreateTool.html","title":"Class: LineCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: LineCreateTool Core.Tools. LineCreateTool Represents the tool for creating Core.Annotations.LineAnnotations. new LineCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.GenericAnnotationCreateTool Members &lt;static&gt; DrawModes An enum representing the draw modes available for creating annotations. Type: string Properties: Name Type Description HOLD_TO_DRAW string The annotation is created by clicking and dragging TWO_CLICKS string The annotation is created by one click for the start point and a second click for the end point TWO_CLICKS_HOLD_TO_DRAW_HYBRID string The annotation is created by clicking and dragging if the click is held down for longer than 400ms, otherwise is created by one click for the start point and a second click for the end point Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.GenericAnnotationCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.GenericAnnotationCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.GenericAnnotationCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getDrawMode() Gets the draw mode for the tool. Returns: The current draw mode of the tool. Type Core.Tools.LineCreateTool.DrawModes getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.GenericAnnotationCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode() Get the current snap mode that will be used to calculate the end point position See: Core.Tools.SnapModes Returns: Enum for a snapping mode for the snapping. Type number keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.GenericAnnotationCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.GenericAnnotationCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.GenericAnnotationCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.GenericAnnotationCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.GenericAnnotationCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.GenericAnnotationCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.GenericAnnotationCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.GenericAnnotationCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.GenericAnnotationCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.GenericAnnotationCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setDrawMode(drawMode) Sets the draw mode for the tool. Parameters: Name Type Description drawMode Tools.LineCreateTool.DrawModes One of the available draw modes. setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.GenericAnnotationCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.GenericAnnotationCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.GenericAnnotationCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.GenericAnnotationCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.GenericAnnotationCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:48-07:00 using the DocStrap template. "},"Core.Tools.ListBoxFormFieldCreateTool.html":{"id":"Core.Tools.ListBoxFormFieldCreateTool.html","title":"Class: ListBoxFormFieldCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: ListBoxFormFieldCreateTool Core.Tools. ListBoxFormFieldCreateTool Represents the tool for creating ListBox Form Field Placeholders new ListBoxFormFieldCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.RectangleCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.RectangleCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.RectangleCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangleCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangleCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.RectangleCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.RectangleCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.RectangleCreateTool#getSnapMode Overrides: Core.Tools.RectangleCreateTool#getSnapMode See: Core.Tools.SnapModes keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.RectangleCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.RectangleCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.RectangleCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.RectangleCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.RectangleCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.RectangleCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.RectangleCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.RectangleCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.RectangleCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.RectangleCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangleCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.RectangleCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.RectangleCreateTool#setSnapMode Overrides: Core.Tools.RectangleCreateTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.RectangleCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.RectangleCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.RectangleCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.RectangleCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangleCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangleCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:48-07:00 using the DocStrap template. "},"Core.Tools.MarqueeZoomTool.html":{"id":"Core.Tools.MarqueeZoomTool.html","title":"Class: MarqueeZoomTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: MarqueeZoomTool Core.Tools. MarqueeZoomTool Represents a tool for DocumentViewer's built-in marquee zoom. new MarqueeZoomTool(docViewer) Creates a new instance of MarqueeZoomTool. Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Properties: Name Type Description setZoomHandler function Sets the function that takes the current zoom level and returns the next zoom level if a mouse click without drag is performed Extends Core.Tools.Tool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:48-07:00 using the DocStrap template. "},"Core.Tools.PageCoordinate.html":{"id":"Core.Tools.PageCoordinate.html","title":"Class: PageCoordinate","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: PageCoordinate Core.Tools. PageCoordinate Represents a point on a page new PageCoordinate() Properties: Name Type Description pageIndex number the 0-based page value x number the x offset of this point relative to the top left corner of the page y number the y offset of this point relative to the top left corner of the page × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:48-07:00 using the DocStrap template. "},"Core.Tools.PanTool.html":{"id":"Core.Tools.PanTool.html","title":"Class: PanTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: PanTool Core.Tools. PanTool Represents a tool for DocumentViewer's built-in mouse pan scrolling. new PanTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Properties: Name Type Argument Description previousStylusTool Core.Tools.Tool &lt;optional&gt; Deprecated Please use previouslyUsedTool instead. The previous tool instance before panning the document in the stylus mode, or pressing mouse wheel button. previouslyUsedTool Core.Tools.Tool &lt;optional&gt; The previous tool instance before panning the document in the stylus mode, or pressing mouse wheel button. Extends Core.Tools.AnnotationSelectTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point isPanning() Checks whether the user is currently panning or not Returns: Type boolean isPinching() Checks whether the user is currently pinching or not Returns: Type boolean keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:48-07:00 using the DocStrap template. "},"Core.Tools.PerimeterMeasurementCreateTool.html":{"id":"Core.Tools.PerimeterMeasurementCreateTool.html","title":"Class: PerimeterMeasurementCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: PerimeterMeasurementCreateTool Core.Tools. PerimeterMeasurementCreateTool Represents the tool for creating polyline annotations with a measure dictionary. new PerimeterMeasurementCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.PolylineCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.PolylineCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.PolylineCreateTool#contextMenu disableCreationOverAnnotation() Prevent the tool from creating new annotations when hovering over an existing annotation. The annotation will be selected instead. Inherited From: Core.Tools.PolylineCreateTool#disableCreationOverAnnotation Overrides: Core.Tools.PolylineCreateTool#disableCreationOverAnnotation disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolylineCreateTool#disableImmediateActionOnAnnotationSelection enableCreationOverAnnotation() Allow the tool to create new annotations when hovering over an existing annotation Inherited From: Core.Tools.PolylineCreateTool#enableCreationOverAnnotation Overrides: Core.Tools.PolylineCreateTool#enableCreationOverAnnotation enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolylineCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.PolylineCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.PolylineCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode() Get the current snap mode that will be used to calculate the end point position Inherited From: Core.Tools.PolylineCreateTool#getSnapMode Overrides: Core.Tools.PolylineCreateTool#getSnapMode See: Core.Tools.SnapModes Returns: Enum for a snapping mode for the snapping. Type number keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.PolylineCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.PolylineCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.PolylineCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.PolylineCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.PolylineCreateTool#mouseMove Overrides: Core.Tools.PolylineCreateTool#mouseMove Returns: A promise that resolves when the method execution is finished Type Promise.&lt;void&gt; mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.PolylineCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.PolylineCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.PolylineCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.PolylineCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.PolylineCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setAllowCreationOverAnnotation(val) Sets whether new annotations can be created by the tool when hovering over an existing annotation Parameters: Name Type Description val boolean Whether creation of annotation is allowed when hovering over another annotation Inherited From: Core.Tools.PolylineCreateTool#setAllowCreationOverAnnotation Overrides: Core.Tools.PolylineCreateTool#setAllowCreationOverAnnotation Deprecated: since version 8.0 Please use enableCreationOverAnnotation or disableCreationOverAnnotation instead setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolylineCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.PolylineCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.PolylineCreateTool#setSnapMode Overrides: Core.Tools.PolylineCreateTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.PolylineCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.PolylineCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.PolylineCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.PolylineCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolylineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolylineCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:48-07:00 using the DocStrap template. "},"Core.Tools.PolygonCloudCreateTool.html":{"id":"Core.Tools.PolygonCloudCreateTool.html","title":"Class: PolygonCloudCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: PolygonCloudCreateTool Core.Tools. PolygonCloudCreateTool Represents the tool for creating Core.Annotations.PolygonAnnotation. new PolygonCloudCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.PolygonCreateTool Members &lt;static&gt; ArcDrawModes Type: string Properties: Name Type Description EQUAL_ARCS string The arcs in the cloud have the same width. This is the default setting RANDOM_ARCS string The arcs in the cloud have random widths Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.PolygonCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.PolygonCreateTool#contextMenu disableCreationOverAnnotation() Prevent the tool from creating new annotations when hovering over an existing annotation. The annotation will be selected instead. Inherited From: Core.Tools.PolylineCreateTool#disableCreationOverAnnotation Overrides: Core.Tools.PolygonCreateTool#disableCreationOverAnnotation disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolygonCreateTool#disableImmediateActionOnAnnotationSelection enableCreationOverAnnotation() Allow the tool to create new annotations when hovering over an existing annotation Inherited From: Core.Tools.PolylineCreateTool#enableCreationOverAnnotation Overrides: Core.Tools.PolygonCreateTool#enableCreationOverAnnotation enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolygonCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getArcDrawMode() Returns the current ArcDrawMode for the tool Returns: the ArcDrawMode Type string getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.PolygonCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.PolygonCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode() Get the current snap mode that will be used to calculate the end point position Inherited From: Core.Tools.PolylineCreateTool#getSnapMode Overrides: Core.Tools.PolygonCreateTool#getSnapMode See: Core.Tools.SnapModes Returns: Enum for a snapping mode for the snapping. Type number keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.PolygonCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.PolygonCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.PolygonCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.PolygonCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.PolylineCreateTool#mouseMove Overrides: Core.Tools.PolygonCreateTool#mouseMove Returns: A promise that resolves when the method execution is finished Type Promise.&lt;void&gt; mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.PolygonCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.PolygonCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.PolygonCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.PolygonCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.PolygonCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setAllowCreationOverAnnotation(val) Sets whether new annotations can be created by the tool when hovering over an existing annotation Parameters: Name Type Description val boolean Whether creation of annotation is allowed when hovering over another annotation Inherited From: Core.Tools.PolylineCreateTool#setAllowCreationOverAnnotation Overrides: Core.Tools.PolygonCreateTool#setAllowCreationOverAnnotation Deprecated: since version 8.0 Please use enableCreationOverAnnotation or disableCreationOverAnnotation instead setArcDrawMode(arcDrawMode) Sets the arc drawing mode for annotations created by the tool Parameters: Name Type Description arcDrawMode string Is either RANDOM_ARCS or EQUAL_ARCs use existing ENUM to pass this value See: Core.Tools.PolygonCloudCreateTool.ArcDrawModes Example const cloudTool = docViewer.getTool('AnnotationCreatePolygonCloud'); cloudTool.setArcDrawMode(instance.Core.Tools.PolygonCloudCreateTool.ArcDrawModes.RANDOM_ARCS); setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolygonCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.PolygonCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.PolylineCreateTool#setSnapMode Overrides: Core.Tools.PolygonCreateTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.PolygonCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.PolygonCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.PolygonCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.PolygonCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolygonCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolygonCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.PolygonCreateTool.html":{"id":"Core.Tools.PolygonCreateTool.html","title":"Class: PolygonCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: PolygonCreateTool Core.Tools. PolygonCreateTool Represents the tool for creating Core.Annotations.PolygonAnnotation. new PolygonCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.PolylineCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.PolylineCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.PolylineCreateTool#contextMenu disableCreationOverAnnotation() Prevent the tool from creating new annotations when hovering over an existing annotation. The annotation will be selected instead. Inherited From: Core.Tools.PolylineCreateTool#disableCreationOverAnnotation Overrides: Core.Tools.PolylineCreateTool#disableCreationOverAnnotation disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolylineCreateTool#disableImmediateActionOnAnnotationSelection enableCreationOverAnnotation() Allow the tool to create new annotations when hovering over an existing annotation Inherited From: Core.Tools.PolylineCreateTool#enableCreationOverAnnotation Overrides: Core.Tools.PolylineCreateTool#enableCreationOverAnnotation enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolylineCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.PolylineCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.PolylineCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode() Get the current snap mode that will be used to calculate the end point position Inherited From: Core.Tools.PolylineCreateTool#getSnapMode Overrides: Core.Tools.PolylineCreateTool#getSnapMode See: Core.Tools.SnapModes Returns: Enum for a snapping mode for the snapping. Type number keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.PolylineCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.PolylineCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.PolylineCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.PolylineCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.PolylineCreateTool#mouseMove Overrides: Core.Tools.PolylineCreateTool#mouseMove Returns: A promise that resolves when the method execution is finished Type Promise.&lt;void&gt; mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.PolylineCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.PolylineCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.PolylineCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.PolylineCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.PolylineCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setAllowCreationOverAnnotation(val) Sets whether new annotations can be created by the tool when hovering over an existing annotation Parameters: Name Type Description val boolean Whether creation of annotation is allowed when hovering over another annotation Inherited From: Core.Tools.PolylineCreateTool#setAllowCreationOverAnnotation Overrides: Core.Tools.PolylineCreateTool#setAllowCreationOverAnnotation Deprecated: since version 8.0 Please use enableCreationOverAnnotation or disableCreationOverAnnotation instead setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.PolylineCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.PolylineCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.PolylineCreateTool#setSnapMode Overrides: Core.Tools.PolylineCreateTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.PolylineCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.PolylineCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.PolylineCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.PolylineCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.PolylineCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.PolylineCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.PolylineCreateTool.html":{"id":"Core.Tools.PolylineCreateTool.html","title":"Class: PolylineCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: PolylineCreateTool Core.Tools. PolylineCreateTool Represents the tool for creating Core.Annotations.PolylineAnnotation. new PolylineCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.GenericAnnotationCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.GenericAnnotationCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.GenericAnnotationCreateTool#contextMenu disableCreationOverAnnotation() Prevent the tool from creating new annotations when hovering over an existing annotation. The annotation will be selected instead. disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#disableImmediateActionOnAnnotationSelection enableCreationOverAnnotation() Allow the tool to create new annotations when hovering over an existing annotation enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.GenericAnnotationCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.GenericAnnotationCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode() Get the current snap mode that will be used to calculate the end point position See: Core.Tools.SnapModes Returns: Enum for a snapping mode for the snapping. Type number keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.GenericAnnotationCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.GenericAnnotationCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.GenericAnnotationCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.GenericAnnotationCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Overrides: Core.Tools.GenericAnnotationCreateTool#mouseMove Returns: A promise that resolves when the method execution is finished Type Promise.&lt;void&gt; mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.GenericAnnotationCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.GenericAnnotationCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.GenericAnnotationCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.GenericAnnotationCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.GenericAnnotationCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setAllowCreationOverAnnotation(val) Sets whether new annotations can be created by the tool when hovering over an existing annotation Parameters: Name Type Description val boolean Whether creation of annotation is allowed when hovering over another annotation Deprecated: since version 8.0 Please use enableCreationOverAnnotation or disableCreationOverAnnotation instead setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.GenericAnnotationCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.GenericAnnotationCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.GenericAnnotationCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.GenericAnnotationCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.GenericAnnotationCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.RadioButtonFormFieldCreateTool.html":{"id":"Core.Tools.RadioButtonFormFieldCreateTool.html","title":"Class: RadioButtonFormFieldCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: RadioButtonFormFieldCreateTool Core.Tools. RadioButtonFormFieldCreateTool Represents the tool for creating RadioButton Form Field Placeholders new RadioButtonFormFieldCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.EllipseCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.EllipseCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.EllipseCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.EllipseCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.EllipseCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.EllipseCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getDrawMode() Gets the draw mode for the tool. Inherited From: Core.Tools.EllipseCreateTool#getDrawMode Overrides: Core.Tools.EllipseCreateTool#getDrawMode Returns: The current draw mode of the tool. Type Core.Tools.EllipseCreateTool.DrawModes getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.EllipseCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.EllipseCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.EllipseCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.EllipseCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.EllipseCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.EllipseCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.EllipseCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.EllipseCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.EllipseCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.EllipseCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.EllipseCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setDrawMode(drawMode) Sets the draw mode for the tool. Parameters: Name Type Description drawMode Core.Tools.EllipseCreateTool.DrawModes One of the available draw modes. Inherited From: Core.Tools.EllipseCreateTool#setDrawMode Overrides: Core.Tools.EllipseCreateTool#setDrawMode setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.EllipseCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.EllipseCreateTool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.EllipseCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.EllipseCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.EllipseCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.EllipseCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.EllipseCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.EllipseCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.RectangleCreateTool.html":{"id":"Core.Tools.RectangleCreateTool.html","title":"Class: RectangleCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: RectangleCreateTool Core.Tools. RectangleCreateTool Represents the tool for creating Core.Annotations.RectangleAnnotations. new RectangleCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.GenericAnnotationCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.GenericAnnotationCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.GenericAnnotationCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.GenericAnnotationCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.GenericAnnotationCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. See: Core.Tools.SnapModes keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.GenericAnnotationCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.GenericAnnotationCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.GenericAnnotationCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.GenericAnnotationCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.GenericAnnotationCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.GenericAnnotationCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.GenericAnnotationCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.GenericAnnotationCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.GenericAnnotationCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.GenericAnnotationCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.GenericAnnotationCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.GenericAnnotationCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.GenericAnnotationCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.GenericAnnotationCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.GenericAnnotationCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.GenericAnnotationCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.RectangularAreaMeasurementTool.html":{"id":"Core.Tools.RectangularAreaMeasurementTool.html","title":"Class: RectangularAreaMeasurementTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: RectangularAreaMeasurementTool Core.Tools. RectangularAreaMeasurementTool Represents the tool for creating rectangular polygon annotations with a measure dictionary. new RectangularAreaMeasurementTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.AreaMeasurementCreateTool Members &lt;static&gt; DrawModes An enum representing the draw modes available for creating annotations. Type: string Properties: Name Type Description HOLD_TO_DRAW string The annotation is created by clicking and dragging TWO_CLICKS string The annotation is created by one click for the start point and a second click for the end point Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.AreaMeasurementCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.AreaMeasurementCreateTool#contextMenu disableCreationOverAnnotation() Prevent the tool from creating new annotations when hovering over an existing annotation. The annotation will be selected instead. Inherited From: Core.Tools.PolylineCreateTool#disableCreationOverAnnotation Overrides: Core.Tools.AreaMeasurementCreateTool#disableCreationOverAnnotation disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.AreaMeasurementCreateTool#disableImmediateActionOnAnnotationSelection enableCreationOverAnnotation() Allow the tool to create new annotations when hovering over an existing annotation Inherited From: Core.Tools.PolylineCreateTool#enableCreationOverAnnotation Overrides: Core.Tools.AreaMeasurementCreateTool#enableCreationOverAnnotation enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.AreaMeasurementCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDefaultMeasurementCaptionOptions() Gets the measurement create tool's default caption options. Inherited From: Core.Tools.AreaMeasurementCreateTool#getDefaultMeasurementCaptionOptions Overrides: Core.Tools.AreaMeasurementCreateTool#getDefaultMeasurementCaptionOptions Returns: The measurement caption options. Type Core.Annotations.measurementCaptionOptions getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.AreaMeasurementCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getDrawMode() Gets the draw mode for the tool. Returns: The current draw mode of the tool. Type Core.Tools.RectangularAreaMeasurementTool.DrawModes getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.AreaMeasurementCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode() Get the current snap mode that will be used to calculate the end point position Inherited From: Core.Tools.PolylineCreateTool#getSnapMode Overrides: Core.Tools.AreaMeasurementCreateTool#getSnapMode See: Core.Tools.SnapModes Returns: Enum for a snapping mode for the snapping. Type number keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.AreaMeasurementCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.AreaMeasurementCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.AreaMeasurementCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.AreaMeasurementCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.PolylineCreateTool#mouseMove Overrides: Core.Tools.AreaMeasurementCreateTool#mouseMove Returns: A promise that resolves when the method execution is finished Type Promise.&lt;void&gt; mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.AreaMeasurementCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.AreaMeasurementCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.AreaMeasurementCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.AreaMeasurementCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.AreaMeasurementCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setAllowCreationOverAnnotation(val) Sets whether new annotations can be created by the tool when hovering over an existing annotation Parameters: Name Type Description val boolean Whether creation of annotation is allowed when hovering over another annotation Inherited From: Core.Tools.PolylineCreateTool#setAllowCreationOverAnnotation Overrides: Core.Tools.AreaMeasurementCreateTool#setAllowCreationOverAnnotation Deprecated: since version 8.0 Please use enableCreationOverAnnotation or disableCreationOverAnnotation instead setDrawMode(drawMode) Sets the draw mode for the tool. Parameters: Name Type Description drawMode Core.Tools.RectangularAreaMeasurementTool.DrawModes One of the available draw modes. setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.AreaMeasurementCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.AreaMeasurementCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.PolylineCreateTool#setSnapMode Overrides: Core.Tools.AreaMeasurementCreateTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.AreaMeasurementCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.AreaMeasurementCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.AreaMeasurementCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.AreaMeasurementCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.AreaMeasurementCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.AreaMeasurementCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.RedactionCreateTool.html":{"id":"Core.Tools.RedactionCreateTool.html","title":"Class: RedactionCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: RedactionCreateTool Core.Tools. RedactionCreateTool Represents the tool for creating Core.Annotations.RedactionAnnotation. new RedactionCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.TextAnnotationCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.TextAnnotationCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.TextAnnotationCreateTool#contextMenu disableAutoSizedText() Disable automatically setting the font size based on the selected text (if redacting text) disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#disableImmediateActionOnAnnotationSelection enableAutoSizedText() Enable automatically setting the font size based on the selected text (if redacting text) enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.TextAnnotationCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.TextAnnotationCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.TextAnnotationCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.TextAnnotationCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.TextAnnotationCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.TextAnnotationCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.TextAnnotationCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.TextAnnotationCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.TextAnnotationCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.TextAnnotationCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.TextAnnotationCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.TextAnnotationCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); select(pagePt1, pagePt2) Select text based on two points Parameters: Name Type Description pagePt1 object The start point to select from. Is an object with pageIndex, x and y properties. pagePt2 object The end point to select to. Is an object with pageIndex, x and y properties. Inherited From: Core.Tools.TextTool#select Overrides: Core.Tools.TextAnnotationCreateTool#select setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setEnableTextAutoSize(enable) Set if tool should automatically set font size based on the selected text (if redacting text) Parameters: Name Type Description enable boolean a boolean indicating whether overlay text font should be automatically set Deprecated: since version 8.0 Please use enableAutoSizedText or disableAutoSizedText instead setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.TextAnnotationCreateTool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.TextAnnotationCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.TextAnnotationCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.TextAnnotationCreateTool#switchOut textSelected(pageNumber, quads, text) The function called when a text region is selected. Parameters: Name Type Description pageNumber number quads Array.&lt;Core.Math.Quad&gt; The array of quad coordinates for the selected text. text string The text selected. Inherited From: Core.Tools.TextTool#textSelected Overrides: Core.Tools.TextAnnotationCreateTool#textSelected trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.TextAnnotationCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.RubberStampCreateTool.html":{"id":"Core.Tools.RubberStampCreateTool.html","title":"Class: RubberStampCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: RubberStampCreateTool Core.Tools. RubberStampCreateTool Represents the tool for creating Core.Annotations.StampAnnotation. new RubberStampCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.Tool Methods addCustomStamp(options) Add a single custom stamp to tool's list Parameters: Name Type Description options Core.Tools.RubberStampCreateTool.CustomStampData The custom stamp data addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.Tool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); addStamp() Add the stamp to the document. Returns: Type Promise.&lt;void&gt; contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.Tool#contextMenu drawCustomStamp(options) Draw custom stamp annotation onto a canvas Parameters: Name Type Description options object An object that can contain the following optional parameters Properties Name Type Argument Description title string &lt;optional&gt; Custom stamp's main text subtitle string &lt;optional&gt; Time format text used as a custom timestamp, e.g. \"DD-MM-YYYY\" To render a plain-text string as a subtitle, place the desired string inside of square brackets e.g. \"[This is a subtitle]\". color string &lt;optional&gt; Fill color value, see Annotation.Color textColor string &lt;optional&gt; Text color value, see Annotation.Color canvas string &lt;optional&gt; Canvas to draw this annotation width string &lt;optional&gt; Default width of stamp height string &lt;optional&gt; Default height of stamp canvasParent string &lt;optional&gt; Parent DOM element of canvas font string &lt;optional&gt; Font family to use for stamp text bold boolean &lt;optional&gt; Whether to use bold styling for the title or not italic boolean &lt;optional&gt; Whether to use italic styling for the title or not underline boolean &lt;optional&gt; Whether to underline the title or not strikeout boolean &lt;optional&gt; Whether to strikeout the title or not getCustomStampAnnotations() Get array of custom annotations. Returns: Type Promise.&lt;Array.&lt;Core.Annotations.StampAnnotation&gt;&gt; getCustomStamps() Returns array of objects representing the custom stamps Returns: An array of objects representing the custom stamps Type Array.&lt;Core.Tools.RubberStampCreateTool.CustomStampData&gt; getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getPreview(annotation, parameters) Gets the preview about how the annot will be drawn on the document Parameters: Name Type Description annotation Core.Annotations.StampAnnotation annotation to get the preview for. parameters Object canvas parameters and optional text for annotation, e.g. translated text. e.g. { canvasHeight: number, canvasWidth: number, text: string } Returns: Returns a promise that resolves a base64 string of the preview image Type Promise.&lt;string&gt; getStandardStampAnnotations() Get array of standard stamp annotations. Returns: Type Promise.&lt;Array.&lt;Core.Annotations.StampAnnotation&gt;&gt; getStandardStamps() Returns array of strings representing the built-in, default stamps Returns: Type Array.&lt;string&gt; getStandardStamps() Returns array of strings representing the standard stamps Returns: An array of objects representing the standard stamps Type Array.&lt;string&gt; hidePreview() Hide the preview element isEmptyStamp() Checks if the underlying annotation is empty. If the underlying annotation is a StampAnnotation type return true. Returns: Type boolean keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.Tool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.Tool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.Tool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.Tool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setCustomDrawFunction(callback) Sets a custom function to be used for drawing extra content on top of custom stamps, enabling customization of the CanvasRenderingContext2D of the Canvas element used for Rubber Stamps Parameters: Name Type Description callback function A callback side effect function that takes a two parameters. The first is assumed to be the type CanvasRenderingContext2D, and modifies the parameter for the purposes of custom drawing behavior on top of the default stamp behavior. The second parameter is optional, and is assumed to be an instance of the Core.Annotations.Annotation class, wherein custom behavior for the stamp annotation being modified can be added (i.e. conditionally apply custom drawing on certain annotations only) Example WebViewer( // ... ).then(instance =&gt; { const { docViewer } = instance; const tool = docViewer.getTool('AnnotationCreateRubberStamp'); tool.setCustomDrawFunction((ctx, annotation) =&gt; { const { Icon } = annotation; // `Icon` contains the text content of the stamp // This example conditionally renders custom content on the stamp only // if the contents of the stamp are in the approved list of stamps to // draw on const stampsToDrawOn = [ 'Approved', 'Completed', 'Final', ]; if (stampsToDrawOn.includes(Icon)) { // Arbitrary example where an image is available in the DOM const img = document.getElementById('my-company-logo'); ctx.drawImage( img, // The image to render 0, // The X coordinate of where to place the image 0, // The Y coordinate of where the place the image 25, // The width of the image in pixels 25, // The height of the image in pixels ); } }); }); setCustomStamps(stamps) Accepts and sets an array of objects representing custom stamps Parameters: Name Type Description stamps Array.&lt;Core.Tools.RubberStampCreateTool.CustomStampData&gt; An array of objects representing custom stamps Example: [ { \"title\": \"Sample Text\", \"subtitle\": \"DD-MM-YYYY\", \"color\": window.Annotations.Color(0,0,0) } ] setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.Tool#setName setRubberStamp(annotation, text) Sets the underlying annotation used by the tool Parameters: Name Type Description annotation Core.Annotations.StampAnnotation Annotation to set text string Text to be set in the stamp Returns: Type Promise.&lt;void&gt; setStandardStamps(stamps) Accepts and sets an array of objects representing standard stamps Parameters: Name Type Description stamps Array.&lt;string&gt; An array of strings representing the standard stamps setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.Tool#setStyles showPreview() Shows the preview about how the underlying annot looks like if it's drawn. switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.Tool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.Tool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); useStamp(options) Have this rubber stamp tool always create a single type of stamp with the specified icon value. Parameters: Name Type Description options object An object that can contain the following optional parameters Properties Name Type Argument Description Icon string The name of the icon can be used, eg: 'SBRejected' | 'SHAccepted' | 'Dot' FillColor Core.Annotations.Color &lt;optional&gt; The color of the stamp. Defaults to black. Width number &lt;optional&gt; The width of the stamp Height number &lt;optional&gt; The Height of the stamp Opacity number &lt;optional&gt; The Opacity of the stamp Type Definitions CustomStampData Type: Object Properties: Name Type Argument Description title string &lt;optional&gt; Custom stamp's main text subtitle string &lt;optional&gt; Time format text used as a custom timestamp, e.g. \"DD-MM-YYYY\" To render a plain-text string as a subtitle, place the desired string inside of square brackets e.g. \"[This is a subtitle]\". color Core.Annotations.Color &lt;optional&gt; Background color value font string &lt;optional&gt; Font family to use for stamp text bold boolean &lt;optional&gt; Whether to use bold styling for the title or not italic boolean &lt;optional&gt; Whether to use italic styling for the title or not underline boolean &lt;optional&gt; Whether to underline the title or not strikeout boolean &lt;optional&gt; Whether to strikeout the title or not Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.StampAnnotation The annotation that was added × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.SignatureCreateTool.html":{"id":"Core.Tools.SignatureCreateTool.html","title":"Class: SignatureCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: SignatureCreateTool Core.Tools. SignatureCreateTool Represents the tool for creating a Signature which is represented by an Core.Annotations.FreeHandAnnotation. new SignatureCreateTool(docViewer) Creates a new instance of the SignatureCreateTool. Parameters: Name Type Description docViewer Core.DocumentViewer an instance of DocumentViewer. Properties: Name Type Description ctx CanvasRenderingContext2D The signature canvas context annot Core.Annotations.FreeHandAnnotation | Core.Annotations.StampAnnotation The underlying annotation used by the tool ACCEPTED_FILE_SIZE number A number specifying the accepted file size in bytes (exclusive). A null, undefined, or value zero and below means no limit. Extends Core.Tools.Tool Methods &lt;static&gt; setTextHandler(textHandler) Parameters: Name Type Description textHandler function A function that should return a string that will be used as the \"sign here\" text addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); addSignature() Add the signature to the document. Returns: A promise that resolves when the signature is added Type Promise.&lt;void&gt; clearLocation() Clear the location which is set when a mouse click is performed clearSignatureCanvas() Clears the signature canvas and the underlying annotation contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu deleteSavedSignature(index) Delete an annotation in the tool Parameters: Name Type Description index number The index of the saved annotation to be deleted exportSignatures() Exports all saved signatures as an array The array can be stringified using JSON.stringify and saved for later use Returns: Returns a promise that resolves an array that contains arrays of path points or a base64 image data Type Promise.&lt;Array.&lt;(string|Array.&lt;Array.&lt;Core.Math.Point&gt;&gt;)&gt;&gt; getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getPreview(annotation) Gets the preview about how the annot will be drawn on the document Parameters: Name Type Description annotation Core.Annotations.FreeHandAnnotation | Core.Annotations.StampAnnotation Returns: A promise that resolves with a base64 string of the preview image Type Promise.&lt;string&gt; getSavedSignatures() Returns the array of saved annotations Returns: an array of annotations Type Array.&lt;(Core.Annotations.FreeHandAnnotation|Core.Annotations.StampAnnotation)&gt; hasLocation() Returns if the signature tool has any location to draw the signature Returns: Type boolean hidePreview() Hide the preview element importSignatures(signatureData) Loads signature data into the signature tool Parameters: Name Type Description signatureData Array.&lt;(string|Array.&lt;Array.&lt;Core.Math.Point&gt;&gt;)&gt; An array contains arrays of path points or base64 image data If the element is a string, a stamp annotation will be saved and the string will be the value of its ImageData property If the element is an array of objects, a freehand annotation will be saved and the array will be its paths Returns: Promise isEmptySignature() Checks if the underlying annotation is empty. If the underlying annotation is a freehand, it's empty if it doesn't have any paths If the underlying annotation is a stamp, it's empty if its ImageData property has a falsy value Returns: If number of drawn paths is 0. Type Promise.&lt;boolean&gt; keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); resizeCanvas() Resize the current signature canvas saveSignatures(annotations) Save an array of freehand or stamp annotations to the signature tool Parameters: Name Type Description annotations Core.Annotations.FreeHandAnnotation | Core.Annotations.StampAnnotation Annotations to be saved to the signature tool setDefaultSignatureOptions(options) Sets the default options for signatures created with the signature tool. Parameters: Name Type Description options object Signature options that should become the default Properties Name Type Description maximumDimensionSize number The maximum size of the signature's largest dimension. Default is 200. setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName setSignature(annotation [, fileSize]) Sets the underlying annotation used by the tool If a base64 string is passed, the underlying annotation will be a stamp annotation with the string being its ImageData Parameters: Name Type Argument Description annotation Core.Annotations.FreeHandAnnotation | Core.Annotations.StampAnnotation | string | Array.&lt;object&gt; Annotation to set fileSize number &lt;optional&gt; A number specifying the size in bytes of the signature file which will be compared with 'ACCEPTED_FILE_SIZE'. Returns: Promise setSignatureCanvas(canvas) Sets the canvas to be used by the signature tool. Parameters: Name Type Description canvas HTMLCanvasElement The canvas that the signature tool uses to draw on. setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles showPreview() Shows the preview about how the underlying annot looks like if it's drawn. switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added fileRejected Triggered when a file has been rejected because of exceeding file size limit Parameters: Name Type Description reasons Object The rejection reasons object Properties Name Type Description reason string Reason why the file was rejected maxSize number Maximum accpted file size in bytes size number Uploaded file size in bytes locationSelected Triggered when a page location has been clicked on by the tool Parameters: Name Type Argument Description pageCoordinates Core.Tools.PageCoordinate Indicates where the tool clicked signatureWidget Core.Annotations.SignatureWidgetAnnotation &lt;optional&gt; The signature widget that was clicked to trigger the event signatureDeleted Triggered when the tool deletes a signature Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was deleted index number The index of the annotation in the list signatureSaved Triggered when the tool saves a signature Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was saved × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.StampCreateTool.html":{"id":"Core.Tools.StampCreateTool.html","title":"Class: StampCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: StampCreateTool Core.Tools. StampCreateTool Represents the tool for creating Core.Annotations.StampAnnotation. new StampCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Properties: Name Type Description ACCEPTED_IMAGE_TYPES string A string specifying the accepted image types to be opened by the file picker default is image/* ACCEPTED_FILE_SIZE number A number specifying the accepted file size in bytes (exclusive). A null, undefined, or value zero and below means no limit. Extends Core.Tools.Tool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.Tool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.Tool#contextMenu getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.Tool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.Tool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.Tool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.Tool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.Tool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.Tool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.Tool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.Tool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added fileRejected Triggered when a file has been rejected because of exceeding file size limit Parameters: Name Type Description reasons Object The rejection reasons object Properties Name Type Description reason string Reason why the file was rejected maxSize number Maximum accpted file size in bytes size number Uploaded file size in bytes fileRejected Triggered when a file has been rejected because of exceeding file size limit Parameters: Name Type Description reasons Object The rejection reasons object Properties Name Type Description reason string Reason why the file was rejected maxSize number Maximum accpted file size in bytes size number Uploaded file size in bytes × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.StickyCreateTool.html":{"id":"Core.Tools.StickyCreateTool.html","title":"Class: StickyCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: StickyCreateTool Core.Tools. StickyCreateTool Represents the tool for creating Core.Annotations.StickyAnnotation. new StickyCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.Tool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.Tool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.Tool#contextMenu disableCreationOverAnnotation() Prevent the tool from creating new annotations when hovering over an existing annotation. The annotation will be selected instead. disableViewStateSaving() When called new annotations will not have a ViewState applied to them. By default no ViewState is applied. ViewState is the state of the viewer when the annotation is created. When the annotation is double clicked and ViewState exists, the viewer state will be set to the ViewState enableCreationOverAnnotation() Allow the tool to create new annotations when hovering over an existing annotation enableViewStateSaving() When enabled, new annotations will have a ViewState applied to them. ViewState is the state of the viewer when the annotation is created. When the annotation is double clicked and ViewState exists, the viewer state will be set to the ViewState getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.Tool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.Tool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.Tool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.Tool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setAllowCreationOverAnnotation(val) Sets whether new annotations can be created by the tool when hovering over an existing annotation Parameters: Name Type Description val boolean Whether creation of annotation is allowed when hovering over another annotation Deprecated: since version 8.0 Please use enableCreationOverAnnotation or disableCreationOverAnnotation instead setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.Tool#setName setSaveViewState(val) Sets whether new annotations have a ViewState applied to them. ViewState is the state of the viewer when the annotation is created. When the annotation is double clicked and ViewState exists, the viewer state will be set to the ViewState Parameters: Name Type Description val boolean Deprecated: since version 8.0 Please use enableViewStateSaving or disableViewStateSaving instead setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.Tool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.Tool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.Tool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.TextAnnotationCreateTool.html":{"id":"Core.Tools.TextAnnotationCreateTool.html","title":"Class: TextAnnotationCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextAnnotationCreateTool Core.Tools. TextAnnotationCreateTool Represents an abstract class for text-based annotation creation tools. new TextAnnotationCreateTool(docViewer, textAnnotationPrototype) This class should not be instantiated. Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. textAnnotationPrototype function The prototype the text-based annotation to create. Properties: Name Type Description defaults Object The default styles of the tool Properties Name Type Description StrokeColor Core.Annotations.Color The stroke color of the tool Opacity number The opacity of the tool Extends Core.Tools.TextTool Members &lt;static&gt; AUTO_SET_TEXT Toggle whether selected text should be set as annotation note contents. False by default. Type: boolean Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); select(pagePt1, pagePt2) Select text based on two points Parameters: Name Type Description pagePt1 object The start point to select from. Is an object with pageIndex, x and y properties. pagePt2 object The end point to select to. Is an object with pageIndex, x and y properties. Inherited From: Core.Tools.TextTool#select setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut textSelected(pageNumber, quads, text) The function called when a text region is selected. Parameters: Name Type Description pageNumber number quads Array.&lt;Core.Math.Quad&gt; The array of quad coordinates for the selected text. text string The text selected. Inherited From: Core.Tools.TextTool#textSelected trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.TextFormFieldCreateTool.html":{"id":"Core.Tools.TextFormFieldCreateTool.html","title":"Class: TextFormFieldCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextFormFieldCreateTool Core.Tools. TextFormFieldCreateTool Represents the tool for creating Text Form Field Placeholders new TextFormFieldCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.RectangleCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.RectangleCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.RectangleCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangleCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangleCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.RectangleCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.RectangleCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point getSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.RectangleCreateTool#getSnapMode Overrides: Core.Tools.RectangleCreateTool#getSnapMode See: Core.Tools.SnapModes keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.RectangleCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.RectangleCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.RectangleCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.RectangleCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.RectangleCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.RectangleCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.RectangleCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.RectangleCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.RectangleCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.RectangleCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.RectangleCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.RectangleCreateTool#setName setSnapMode(mode) Set the snap mode that will be used to calculate the end point position Parameters: Name Type Description mode number Enum for a snapping mode for the snapping. Inherited From: Core.Tools.RectangleCreateTool#setSnapMode Overrides: Core.Tools.RectangleCreateTool#setSnapMode See: Core.Tools.SnapModes setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.RectangleCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.RectangleCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.RectangleCreateTool#switchOut trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.RectangleCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.RectangleCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.GenericAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.RectangleCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.TextHighlightCreateTool.html":{"id":"Core.Tools.TextHighlightCreateTool.html","title":"Class: TextHighlightCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextHighlightCreateTool Core.Tools. TextHighlightCreateTool Represents the tool for creating Core.Annotations.TextHighlightAnnotation. new TextHighlightCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.TextAnnotationCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.TextAnnotationCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.TextAnnotationCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.TextAnnotationCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.TextAnnotationCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.TextAnnotationCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.TextAnnotationCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.TextAnnotationCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.TextAnnotationCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.TextAnnotationCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.TextAnnotationCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.TextAnnotationCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.TextAnnotationCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.TextAnnotationCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.TextAnnotationCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); select(pagePt1, pagePt2) Select text based on two points Parameters: Name Type Description pagePt1 object The start point to select from. Is an object with pageIndex, x and y properties. pagePt2 object The end point to select to. Is an object with pageIndex, x and y properties. Inherited From: Core.Tools.TextTool#select Overrides: Core.Tools.TextAnnotationCreateTool#select setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.TextAnnotationCreateTool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.TextAnnotationCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.TextAnnotationCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.TextAnnotationCreateTool#switchOut textSelected(pageNumber, quads, text) The function called when a text region is selected. Parameters: Name Type Description pageNumber number quads Array.&lt;Core.Math.Quad&gt; The array of quad coordinates for the selected text. text string The text selected. Inherited From: Core.Tools.TextTool#textSelected Overrides: Core.Tools.TextAnnotationCreateTool#textSelected trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.TextAnnotationCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.TextSelectTool.html":{"id":"Core.Tools.TextSelectTool.html","title":"Class: TextSelectTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextSelectTool Core.Tools. TextSelectTool Represents a tool for DocumentViewer's built-in text selection. new TextSelectTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.TextTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); select(pagePt1, pagePt2) Select text based on two points Parameters: Name Type Description pagePt1 object The start point to select from. Is an object with pageIndex, x and y properties. pagePt2 object The end point to select to. Is an object with pageIndex, x and y properties. Inherited From: Core.Tools.TextTool#select setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut textSelected(pageNumber, quads, text) The function called when a text region is selected. Parameters: Name Type Description pageNumber number quads Array.&lt;Core.Math.Quad&gt; The array of quad coordinates for the selected text. text string The text selected. Inherited From: Core.Tools.TextTool#textSelected trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events selectionComplete Triggered when the user has released the mouse after selecting text Parameters: Name Type Description startLocation object An object with keys \"quad\" and \"pageNumber\" which is the starting quad and page number of the text selection allQuads object An object with keys being the page numbers and values being an array of quads for the selected text on that page × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.TextSquigglyCreateTool.html":{"id":"Core.Tools.TextSquigglyCreateTool.html","title":"Class: TextSquigglyCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextSquigglyCreateTool Core.Tools. TextSquigglyCreateTool Represents the tool for creating Core.Annotations.TextSquigglyAnnotation. new TextSquigglyCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.TextAnnotationCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.TextAnnotationCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.TextAnnotationCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.TextAnnotationCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.TextAnnotationCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.TextAnnotationCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.TextAnnotationCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.TextAnnotationCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.TextAnnotationCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.TextAnnotationCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.TextAnnotationCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.TextAnnotationCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.TextAnnotationCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.TextAnnotationCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.TextAnnotationCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); select(pagePt1, pagePt2) Select text based on two points Parameters: Name Type Description pagePt1 object The start point to select from. Is an object with pageIndex, x and y properties. pagePt2 object The end point to select to. Is an object with pageIndex, x and y properties. Inherited From: Core.Tools.TextTool#select Overrides: Core.Tools.TextAnnotationCreateTool#select setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.TextAnnotationCreateTool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.TextAnnotationCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.TextAnnotationCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.TextAnnotationCreateTool#switchOut textSelected(pageNumber, quads, text) The function called when a text region is selected. Parameters: Name Type Description pageNumber number quads Array.&lt;Core.Math.Quad&gt; The array of quad coordinates for the selected text. text string The text selected. Inherited From: Core.Tools.TextTool#textSelected Overrides: Core.Tools.TextAnnotationCreateTool#textSelected trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.TextAnnotationCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.TextStrikeoutCreateTool.html":{"id":"Core.Tools.TextStrikeoutCreateTool.html","title":"Class: TextStrikeoutCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextStrikeoutCreateTool Core.Tools. TextStrikeoutCreateTool Represents the tool for creating Core.Annotations.TextStrikeoutAnnotation. new TextStrikeoutCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.TextAnnotationCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.TextAnnotationCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.TextAnnotationCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.TextAnnotationCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.TextAnnotationCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.TextAnnotationCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.TextAnnotationCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.TextAnnotationCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.TextAnnotationCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.TextAnnotationCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.TextAnnotationCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.TextAnnotationCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.TextAnnotationCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.TextAnnotationCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.TextAnnotationCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); select(pagePt1, pagePt2) Select text based on two points Parameters: Name Type Description pagePt1 object The start point to select from. Is an object with pageIndex, x and y properties. pagePt2 object The end point to select to. Is an object with pageIndex, x and y properties. Inherited From: Core.Tools.TextTool#select Overrides: Core.Tools.TextAnnotationCreateTool#select setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.TextAnnotationCreateTool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.TextAnnotationCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.TextAnnotationCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.TextAnnotationCreateTool#switchOut textSelected(pageNumber, quads, text) The function called when a text region is selected. Parameters: Name Type Description pageNumber number quads Array.&lt;Core.Math.Quad&gt; The array of quad coordinates for the selected text. text string The text selected. Inherited From: Core.Tools.TextTool#textSelected Overrides: Core.Tools.TextAnnotationCreateTool#textSelected trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.TextAnnotationCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.TextTool.html":{"id":"Core.Tools.TextTool.html","title":"Class: TextTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextTool Core.Tools. TextTool Represents an extendable class for text-based tool. new TextTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Properties: Name Type Description SELECTION_MODE string Selection mode used by text tools ('structural' or 'rectangular') Extends Core.Tools.AnnotationSelectTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); select(pagePt1, pagePt2) Select text based on two points Parameters: Name Type Description pagePt1 object The start point to select from. Is an object with pageIndex, x and y properties. pagePt2 object The end point to select to. Is an object with pageIndex, x and y properties. setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut textSelected(pageNumber, quads, text) The function called when a text region is selected. Parameters: Name Type Description pageNumber number quads Array.&lt;Core.Math.Quad&gt; The array of quad coordinates for the selected text. text string The text selected. trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.TextUnderlineCreateTool.html":{"id":"Core.Tools.TextUnderlineCreateTool.html","title":"Class: TextUnderlineCreateTool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextUnderlineCreateTool Core.Tools. TextUnderlineCreateTool Represents the tool for creating Core.Annotations.TextUnderlineAnnotation. new TextUnderlineCreateTool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Extends Core.Tools.TextAnnotationCreateTool Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Overrides: Core.Tools.TextAnnotationCreateTool#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object Inherited From: Core.Tools.Tool#contextMenu Overrides: Core.Tools.TextAnnotationCreateTool#contextMenu disableImmediateActionOnAnnotationSelection() Disable whether the tool should trigger an action immediately after clicking an annotation. When this is disabled you need to first click on annotation to select it before you can drag it. This behavior is disabled by default. Inherited From: Core.Tools.AnnotationSelectTool#disableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#disableImmediateActionOnAnnotationSelection enableImmediateActionOnAnnotationSelection() Sets if the tool should trigger actions immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Inherited From: Core.Tools.AnnotationSelectTool#enableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#enableImmediateActionOnAnnotationSelection Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.enableImmediateActionOnAnnotationSelection(); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.enableImmediateActionOnAnnotationSelection(); } } getDocumentViewer() Returns the instance of DocumentViewer for this tool. Inherited From: Core.Tools.Tool#getDocumentViewer Overrides: Core.Tools.TextAnnotationCreateTool#getDocumentViewer Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Inherited From: Core.Tools.Tool#getMouseLocation Overrides: Core.Tools.TextAnnotationCreateTool#getMouseLocation Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. Inherited From: Core.Tools.Tool#keyDown Overrides: Core.Tools.TextAnnotationCreateTool#keyDown mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseDoubleClick Overrides: Core.Tools.TextAnnotationCreateTool#mouseDoubleClick mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftDown Overrides: Core.Tools.TextAnnotationCreateTool#mouseLeftDown mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseLeftUp Overrides: Core.Tools.TextAnnotationCreateTool#mouseLeftUp mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseMove Overrides: Core.Tools.TextAnnotationCreateTool#mouseMove mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. Inherited From: Core.Tools.Tool#mouseRightDown Overrides: Core.Tools.TextAnnotationCreateTool#mouseRightDown off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Overrides: Core.Tools.TextAnnotationCreateTool#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Overrides: Core.Tools.TextAnnotationCreateTool#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Overrides: Core.Tools.TextAnnotationCreateTool#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Overrides: Core.Tools.TextAnnotationCreateTool#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); select(pagePt1, pagePt2) Select text based on two points Parameters: Name Type Description pagePt1 object The start point to select from. Is an object with pageIndex, x and y properties. pagePt2 object The end point to select to. Is an object with pageIndex, x and y properties. Inherited From: Core.Tools.TextTool#select Overrides: Core.Tools.TextAnnotationCreateTool#select setEnableImmediateActionOnAnnotationSelection(enable) Set if the tool should trigger action immediately after clicking an annotation. For example, if this is enabled then you can immediately click and drag an annotation without making a separate click to select the annotation. Parameters: Name Type Description enable boolean A boolean indicating whether actions are triggered immediately on clicking on an annotation Inherited From: Core.Tools.AnnotationSelectTool#setEnableImmediateActionOnAnnotationSelection Overrides: Core.Tools.TextAnnotationCreateTool#setEnableImmediateActionOnAnnotationSelection Deprecated: since version 8.0 Please use enableImmediateActionOnAnnotationSelection or disableImmediateActionOnAnnotationSelection instead Example To enable this for one tool (The Pan tool, for example), this can be done: const tool = docViewer.getTool(window.Core.Tools.ToolNames.PAN); tool.setEnableImmediateActionOnAnnotationSelection(true); To enable this for all selection tools, this can be done: const allTools = Object.values(docViewer.getToolModeMap()); for (const tool of allTools) { if (tool instanceof Tools.AnnotationSelectTool) { tool.setEnableImmediateActionOnAnnotationSelection(true); } } setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool Inherited From: Core.Tools.Tool#setName Overrides: Core.Tools.TextAnnotationCreateTool#setName setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. Inherited From: Core.Tools.Tool#setStyles Overrides: Core.Tools.TextAnnotationCreateTool#setStyles switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. Inherited From: Core.Tools.Tool#switchIn Overrides: Core.Tools.TextAnnotationCreateTool#switchIn switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. Inherited From: Core.Tools.Tool#switchOut Overrides: Core.Tools.TextAnnotationCreateTool#switchOut textSelected(pageNumber, quads, text) The function called when a text region is selected. Parameters: Name Type Description pageNumber number quads Array.&lt;Core.Math.Quad&gt; The array of quad coordinates for the selected text. text string The text selected. Inherited From: Core.Tools.TextTool#textSelected Overrides: Core.Tools.TextAnnotationCreateTool#textSelected trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Overrides: Core.Tools.TextAnnotationCreateTool#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Events annotationAdded Triggered when an annotation has been added to the document by the tool Parameters: Name Type Description annotation Core.Annotations.Annotation The annotation that was added Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationAdded Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationAdded annotationCreated Triggered when an annotation has been created by the tool Parameters: Name Type Description annotations Core.Annotations.Annotation The annotation that was created Inherited From: Core.Tools.TextAnnotationCreateTool#event:annotationCreated Overrides: Core.Tools.TextAnnotationCreateTool#event:annotationCreated × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"Core.Tools.Tool.html":{"id":"Core.Tools.Tool.html","title":"Class: Tool","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Tool Core.Tools. Tool Represents the base class for DocumentViewer UI tools. new Tool(docViewer) Parameters: Name Type Description docViewer Core.DocumentViewer An instance of DocumentViewer. Properties: Name Type Argument Description docViewer Core.DocumentViewer the reference to the current DocumentViewer instance pageCoordinates Array.&lt;Core.Tools.PageCoordinate&gt; an array of page coordinates this tool currently holds. The default is index 0 for the mouse left down and index 1 for mouse left up. name string &lt;optional&gt; The name of the tool cursor string The name of the default mouse cursor used when the tool is active Extends Core.EventHandler Members &lt;static&gt; ALLOW_ANNOTS_OUTSIDE_PAGE A boolean indicating whether annotations can be dragged outside of the page boundaries. Default is false. Type: boolean &lt;static&gt; ENABLE_ANNOTATION_HOVER_CURSORS A boolean indicating whether the cursor should change when hovering over annotations. Default is true. Type: boolean &lt;static&gt; ENABLE_AUTO_SWITCH A boolean indicating whether the text select tool should automatically switch if the cursor is hovering over text or not Type: boolean &lt;static&gt; ENABLE_TEXT_SELECTION A boolean indicating whether text selection is enabled Type: boolean Methods &lt;static&gt; allowAnnotationsOutsidePage() Annotations will be allowed to be dragged outside of the page boundaries. &lt;static&gt; disableAnnotationHoverCursors() The cursor will not change when hovering over annotations. &lt;static&gt; disableAutoSwitch() The text select tool will not automatically switch if the cursor is hovering over text. &lt;static&gt; disableTextSelection() Disable text selection. &lt;static&gt; disallowAnnotationsOutsidePage() Annotations will not be allowed to be dragged outside of the page boundaries. &lt;static&gt; enableAnnotationHoverCursors() The cursor will change when hovering over annotations. &lt;static&gt; enableAutoSwitch() The text select tool will automatically switch if the cursor is hovering over text. &lt;static&gt; enableTextSelection() Enable text selection. addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); contextMenu(e) The function is called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu. Parameters: Name Type Description e The event object getDocumentViewer() Returns the instance of DocumentViewer for this tool. Returns: The instance of DocumentViewer for this tool. Type Core.DocumentViewer getMouseLocation(e) Takes an event object from a mouse event and converts the location into window coordinates Parameters: Name Type Description e The event object containing mouse coordinates Returns: Returns an object with x and y coordinates of the mouse cursor in the viewer Type Core.Math.Point keyDown(e) The function is called when a keyboard key is down. Parameters: Name Type Description e The event object containing keyboard key data. mouseDoubleClick(e) The function is called when the mouse left button is double clicked. Parameters: Name Type Description e The event object containing mouse coordinates. mouseLeftDown(e) The function called when the left mouse button is down Parameters: Name Type Description e The event object containing mouse coordinates. mouseLeftUp(e) The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point. Parameters: Name Type Description e The event object containing mouse coordinates. mouseMove(e) The function called when the mouse moves. Parameters: Name Type Description e The event object containing mouse coordinates. mouseRightDown(e) The function called when the right mouse button is down. Parameters: Name Type Description e The event object containing mouse coordinates. off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setName(name) Set the name of the tool, which can be accessed by toolObject.name Parameters: Name Type Description name string Name of the tool setStyles(newStyles) Set the style for the tool, which will be applied to annotations drawn afterwards Parameters: Name Type Description newStyles object | function 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. switchIn(oldTool) The function is called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool. Parameters: Name Type Description oldTool Core.Tools.Tool The Tool class that was previously selected. switchOut(newTool) The function is called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool. Parameters: Name Type Description newTool Core.Tools.Tool The Tool class that was newly selected. trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"TextHighlightAnnotation.html":{"id":"TextHighlightAnnotation.html","title":"Class: TextHighlightAnnotation","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: TextHighlightAnnotation TextHighlightAnnotation new TextHighlightAnnotation() The maximum opacity for drawing the text highlight annotation. Default is 0.3; This variable is independent of the \"opacity\" field of the annotation is never serialized. × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:49-07:00 using the DocStrap template. "},"UI.html":{"id":"UI.html","title":"Namespace: UI","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: UI UI WebViewer Instance UI namespace. Contains functions and properties related to UI related parts of WebViewer Example webViewerInstance.UI.someProperty webViewerInstance.UI.someAPI() Classes Header MentionsManager Namespaces Fonts Hotkeys NotesPanel TabManager ThumbnailsPanel VerificationOptions Members &lt;static&gt; annotationPopup An instance of Popup that can be used to edit items in the annotation popup component Type: UI.Popup Implements: UI.Popup Example WebViewer(...) .then(function (instance) { instance.UI.annotationPopup.someAPI(); }); &lt;static&gt; contextMenuPopup An instance of Popup that can be used to edit items in the context menu popup component Type: UI.Popup Implements: UI.Popup Example WebViewer(...) .then(function (instance) { instance.UI.contextMenuPopup.someAPI(); }); &lt;static&gt; Events Contains string enums for WebViewer UI events. Properties: Name Type Description ANNOTATION_FILTER_CHANGED string UI.Events.annotationFilterChanged DOCUMENT_LOADED string UI.Events.documentLoaded DOCUMENT_MERGED string UI.Events.documentMerged FILE_DOWNLOADED string UI.Events.fileDownloaded FINISHED_SAVING_PDF string UI.Events.finishedSavingPDF LOAD_ERROR string UI.Events.loaderror DRAG_OUTLINE string UI.Events.dragOutline DROP_OUTLINE string UI.Events.dragOutline PANEL_RESIZED string UI.Events.panelResized THEME_CHANGED string UI.Events.themeChanged TOOLBAR_GROUP_CHANGED string UI.Events.toolbarGroupChanged SELECTED_THUMBNAIL_CHANGED string UI.Events.selectedThumbnailChanged THUMBNAIL_DRAGGED string UI.Events.thumbnailDragged THUMBNAIL_DROPPED string UI.Events.thumbnailDropped USER_BOOKMARKS_CHANGED string UI.Events.userBookmarksChanged OUTLINE_BOOKMARKS_CHANGED string UI.Events.outlineBookmarksChanged VIEWER_LOADED string UI.Events.viewerLoaded VISIBILITY_CHANGED string UI.Events.visibilityChanged FULLSCREEN_MODE_TOGGLED string UI.Events.fullscreenModeToggled BEFORE_TAB_CHANGED string UI.Events.beforeTabChanged TAB_DELETED string UI.Events.tabDeleted TAB_ADDED string UI.Events.tabAdded TAB_MOVED string UI.Events.tabMoved Example WebViewer(...).then(function(instance) { const UIEvents = instance.UI.Events; instance.UI.addEventListener(UIEvents.ANNOTATION_FILTER_CHANGED, e =&gt; { const { types, authors, colors } = e.detail; console.log(types, authors, colors); }); }); &lt;static&gt; Feature Contains string enums for all features for WebViewer UI Properties: Name Type Description Measurement string Measurement tools that can create annotations to measure distance, perimeter and area. Ribbons string A collection of toolbar groups to switch between. Annotations string Render annotations in the document and be able to edit them. Download string A download button to download the current document. FilePicker string Ctrl/Cmd + O hotkey and a open file button that can be clicked to load local files. LocalStorage string Store and retrieve tool styles from window.localStorage. NotesPanel string A panel that displays information of listable annotations. Print string Ctrl/Cmd + P hotkey and a print button that can be clicked to print the current document. Redaction string Redaction tools that can redact text or areas. Need fullAPI to be on to use this feature. TextSelection string Ability to select text in a document. TouchScrollLock string Lock document scrolling in one direction in mobile devices. Copy string Ability to copy text or annotations use Ctrl/Cmd + C hotkeys or the copy button. MultipleViewerMerging string Ability to drag and drop pages from one instance of WebViewer into another ThumbnailMerging string Ability to drag and drop a file into the thumbnail panel to merge ThumbnailReordering string Ability to reorder pages using the thumbnail panel PageNavigation string Ability to navigate through pages using mouse wheel, arrow up/down keys and the swipe gesture. MouseWheelZoom string Ability to zoom when holding ctrl/cmd + mouse wheel. Search string Ctrl/Cmd + F hotkey and a search button that can be clicked to search the current document. MathSymbols string Ability to add math symbols in free text editor OutlineEditing string Ability to add, move and delete outlines in the outlines panel. This feature is only available when `fullAPI: true` is used. NotesPanelVirtualizedList string Ability to use a virtualized list in the note panel. Will limit the number of notes rendered on the DOM NotesShowLastUpdatedDate string Show last updated date in notes panel instead of created date MultiTab string toggle feature to open multiple documents in the same viewer instance Example WebViewer(...) .then(function(instance) { var Feature = instance.UI.Feature; instance.UI.enableFeatures([Feature.Measurement]); instance.UI.disableFeatures([Feature.Copy]); }); &lt;static&gt; FitMode Contains all possible modes for fitting/zooming pages to the viewer. The behavior may vary depending on the LayoutMode. Properties: Name Type Description FitPage string A fit mode where the zoom level is fixed to the width or height of the page, whichever is smaller. FitWidth string A fit mode where the zoom level is fixed to the width of the page. Zoom string A fit mode where the zoom level is not fixed. Example WebViewer(...) .then(function(instance) { var FitMode = instance.UI.FitMode; instance.UI.setFitMode(FitMode.FitWidth); }); &lt;static&gt; hotkeys An instance of Hotkeys that can be used to enable, disable or register custom hotkeys in the viewer Type: Class.&lt;UI.Hotkeys&gt; See: UI.Hotkeys &lt;static&gt; iframeWindow WebViewer iframe window object Type: Window Example WebViewer(...) .then(function(instance) { const iframeWindow = instance.UI.iframeWindow; // iframeWindow.SomeNamespace // iframeWindow.document.querySelector('.some-element'); }); &lt;static&gt; LayoutMode Contains string enums for all layouts for WebViewer. They are used to dictate how pages are placed within the viewer. Properties: Name Type Description Single string Only the current page will be visible. Continuous string All pages are visible in one column. Facing string Up to two pages will be visible. FacingContinuous string All pages visible in two columns. FacingCover string All pages visible in two columns, with an even numbered page rendered first. (i.e. The first page of the document is rendered by itself on the right side of the viewer to simulate a book cover.) FacingCoverContinuous string All pages visible, with an even numbered page rendered first. (i.e. The first page of the document is rendered by itself on the right side of the viewer to simulate a book cover.) Example WebViewer(...) .then(function(instance) { const LayoutMode = instance.UI.LayoutMode; instance.UI.setLayoutMode(LayoutMode.Single); }); &lt;static&gt; mentions An instance of MentionsManager that can be used to allow mentioning people in a textarea in the notes panel. Type: UI.MentionsManager See: UI.MentionsManager &lt;static&gt; NotesPanelSortStrategy Contains string enums for all the possible sorting algorithms available in NotesPanel. Properties: Name Type Description POSITION string Sort notes by position. CREATED_DATE string Sort notes by creation date. MODIFIED_DATE string Sort notes by last modification date. STATUS string Sort notes by status. AUTHOR string Sort notes by the author. TYPE string Sort notes by type. COLOR string Sort notes by color. Example WebViewer(...) .then(function(instance) { const sortStrategy = instance.UI.NotesPanelSortStrategy; instance.UI.setNotesPanelSortStrategy(sortStrategy.AUTHOR); }); &lt;static&gt; pageManipulationsOverlay An instance of PageManipulationsOverlay that can be used to edit the items included in the overlay Type: UI.PageManipulationOverlay Implements: UI.PageManipulationOverlay Example WebViewer(...) .then(function (instance) { instance.UI.pageManipulationOverlay.someAPI(); }) &lt;static&gt; RedactionSearchPatterns Available search patterns that can be passed to UI.replaceRedactionSearchPattern. Type: string Properties: Name Type Description EMAILS string Search pattern for emails CREDIT_CARDS string Search pattern for credit card numbers PHONE_NUMBERS string Search pattern for phone numbers &lt;static&gt; settingsMenuOverlay An instance of MenuOverlay that can be used to edit items in the settings menu overlay component. Type: UI.MenuOverlay Implements: UI.MenuOverlay Example WebViewer(...) .then(function (instance) { instance.UI.settingsMenuOverlay.someAPI(); }); &lt;static&gt; textPopup An instance of Popup that can be used to edit items in the text popup component Type: UI.Popup Implements: UI.Popup Example WebViewer(...) .then(function (instance) { instance.UI.textPopup.someAPI(); }); &lt;static&gt; thumbnailControlMenu An instance of ThumbnailControlMenu that can be used to edit the items included in the thumbnail menu overlay Type: UI.ThumbnailControlMenu Implements: UI.ThumbnailControlMenu Example WebViewer(...) .then(function (instance) { instance.UI.thumbnailControlMenu.someAPI(); }) &lt;static&gt; ToolbarGroup Contains string enums for all toolbar options for WebViewer. Properties: Name Type Description VIEW string Sets the current toolbar as the view group. ANNOTATE string Sets the current toolbar as the annotate group. SHAPES string Sets the current toolbar as the shapes group. INSERT string Sets the current toolbar as the insert group. MEASURE string Sets the current toolbar as the measure group. EDIT string Sets the current toolbar as the edit group. FILL_AND_SIGN string Sets the current toolbar as the fill and sign group. FORMS string Sets the current toolbar as the forms group. Example WebViewer(...) .then(function(instance) { instance.UI.setToolbarGroup(instance.UI.ToolbarGroup.VIEW); }); VerificationOptions VerificationOptions namespace See: VerificationOptions Methods &lt;static&gt; addCustomModal(options) Add custom modal element to WebViewer. Controlling custom modals is done using the element API, for example openElements, closeElements, toggleElement, and disableElements. dateElement string passed on these function should be same as you set in options.dataElement. Every custom modal will add new &lt;div&gt; element with CustomModal and &lt;options.dataElement string&gt; set as class attribute Modal with identical options.dataElement will get replaced by the latest modal options. For styling these components, see Customizing WebViewer UI Styles Note that in most cases WebViewer is run inside an iframe and in order for options.disableEscapeKeyDown to automatically work, the iframe must be the active element. This can be done by setting the focus to the iframe programmatically. Parameters: Name Type Description options object Properties Name Type Argument Default Description dataElement string Unique name of custom modal. disableBackdropClick boolean &lt;optional&gt; false Disable closing modal when user clicks outside of content area disableEscapeKeyDown boolean &lt;optional&gt; false Disable closing modal when user hit escape from keyboard render UI.renderCustomModal Function rendering custom model contents, this is optional header object JSON object with title, className, style and children parameter body object JSON object with title, className, style and children parameter footer object JSON object with title, className, style and children parameter Example WebViewer(...).then(function(instance) { const modal = { dataElement: 'meanwhileInFinlandModal', header: { title: 'Modal header', className: 'myCustomModal-header', style: {}, // optional inline styles children: [] }, body: { className: 'myCustomModal-body', style: {}, // optional inline styles children: [ divInput1, divInput2 ], // HTML dom elements }, footer: { className: 'myCustomModal-footer footer', style: {}, // optional inline styles children: [ { title: 'Cancel', button: true, style: {}, className: 'modal-button cancel-form-field-button', onClick: (e) =&gt; { console.log('ff') } }, { title: 'OK', button: true, style: {}, className: 'modal-button confirm ok-btn', onClick: (e) =&gt; { console.log('xx') } }, ] } }; instance.UI.addCustomModal(modal); instance.UI.openElements([modal.dataElement]); }); &lt;static&gt; addDateTimeFormat(dateTimeFormat) Adds a date and time format for the UI date and time dropdowns. List of formats can be found here: dayjs API. Parameters: Name Type Description dateTimeFormat object An object containing the date and time formats with the respective keys. At least one of the date or time keys must be present. Properties Name Type Argument Description date string &lt;optional&gt; String of date format time string &lt;optional&gt; String of time format timeFirst boolean &lt;optional&gt; Boolean value to indicate if time should be before date in UI Example WebViewer(...) .then(function(instance) { instance.UI.addDateTimeFormat({ date: 'MM/DD/YYYY', time: 'HH:mm:ss', timeFirst: true }); }); &lt;static&gt; addEventListener(eventName, listener) Add an event listener for the given WebViewer UI event. Parameters: Name Type Description eventName string UI event name. listener function Callback function that will be invoked when the event is dispatched. Example WebViewer(...) .then(function(instance) { instance.UI.addEventListener(instance.UI.Events.ANNOTATION_FILTER_CHANGED, e =&gt; { const { types, authors, colors } = e.detail; console.log(types, authors, colors); }); }); &lt;static&gt; addRedactionSearchPattern(searchPattern) Adds a new search pattern to the redaction search panel Parameters: Name Type Description searchPattern UI.RedactionSearchPattern A search pattern to add to the redaction search panel Example WebViewer(...) .then(function(instance) { instance.UI.addRedactionSearchPattern( { label: 'Social Security Number', icon: '&lt;svg xmlns=\"http://www.w3.org/2000/svg\" height=\"24\" width=\"24\" viewBox=\"0 0 30 30\"&gt;&lt;path d=\"M0 0h24v24H0z\" fill=\"none\"/&gt;&lt;path d=\"M17 3H5c-1.11 0-2 .9-2 2v14c0 1.1.89 2 2 2h14c1.1 0 2-.9 2-2V7l-4-4zm-5 16c-1.66 0-3-1.34-3-3s1.34-3 3-3 3 1.34 3 3-1.34 3-3 3zm3-10H5V5h10v4z\"/&gt;&lt;/svg&gt;', type: 'socialSecurityNumber', regex: /\\b\\d{3}-?\\d{2}-?\\d{4}\\b/, } ); }); // Or to search kewyord(s): WebViewer(...) .then(function(instance) { instance.UI.addRedactionSearchPattern( { label: 'Confidential Information', type: 'confidentialInformation', regex: /confidential information/i, //Regex based search for text, case insensitive } ); }); &lt;static&gt; addSearchListener(searchListener) Adds a listener function to be called when search is completed. Parameters: Name Type Description searchListener UI.searchListener Callback function that will be triggered when search completed Example WebViewer(...) .then(function(instance) { function searchListener(searchValue, options, results) { console.log(searchValue, options, results); }; instance.UI.addSearchListener(searchListener); }); &lt;static&gt; addSortStrategy(sortStrategy) Adds a sorting strategy in notes panel. Parameters: Name Type Description sortStrategy object Sorting strategy that will be used to sort notes Properties Name Type Description name string Name of the strategy, which will be shown in notes panel's dropdown getSortedNotes UI.getSortedNotes Function that takes unsorted notes (annotations) and returns them sorted shouldRenderSeparator UI.shouldRenderSeparator Function that returns when a separator should be rendered getSeparatorContent UI.getSeparatorContent Function that returns the content of a separator Example WebViewer(...) .then(function(instance) { var mySortStrategy = { name: 'annotationType', getSortedNotes: function(notes) { return notes.sort(function(a ,b) { if (a.Subject &lt; b.Subject) return -1; if (a.Subject &gt; b.Subject) return 1; if (a.Subject === b.Subject) return 0; }); }, shouldRenderSeparator: function(prevNote, currNote) { return prevNote.Subject !== currNote.Subject; }, getSeparatorContent: function(prevNote, currNote) { return currNote.Subject; } }; instance.UI.addSortStrategy(mySortStrategy); }); &lt;static&gt; cancelPrint() Stops on-going page processing to cancel a print job. Example WebViewer(...) .then(function(instance) { var docViewer = instance.Core.documentViewer; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { instance.UI.print(); instance.UI.cancelPrint(); }); }); &lt;static&gt; closeDocument() Closes the document that's currently opened. Returns: A promise resolved after document is closed. Type Promise.&lt;void&gt; Example WebViewer(...) .then(function(instance) { const docViewer = instance.Core.documentViewer; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { setTimeout(function() { instance.UI.closeDocument().then(function() { console.log('Document is closed'); }); }, 3000); }); }); &lt;static&gt; closeElements(dataElements) Sets visibility states of the elements to be hidden. Note that closeElements works only for panel/overlay/popup/modal elements. Parameters: Name Type Description dataElements Array.&lt;string&gt; Array of data-element attribute values for DOM elements. To find data-element of a DOM element, refer to Finding data-element attribute values. Example WebViewer(...) .then(function(instance) { // closes (hides) text popup and left panel in the UI instance.UI.closeElements([ 'menuOverlay', 'leftPanel' ]); }); &lt;static&gt; createToolbarGroup(toolbarGroup) Creates a new Toolbar group (Ribbon) Parameters: Name Type Description toolbarGroup object Properties Name Type Argument Description name string The label for the new Toolbar Group or the key value to get the label from translation files. Refer to the lib/ui/i18n folder to find the existing keys in the translation files dataElementSuffix string The suffix value you want to use to select your Toolbar group by data element. All toolbar groups have the data element in this format toolbarGroup-&lt;dataElementSuffix&gt;. For example, if you set the dataElementSuffix as 'Draw', the dataElement of your ribbon will be toolbarGroup-Draw children Array A list of elements to be added on the toolbar group header. Check this guide to see the available options to be used as a toolbar group child. useDefaultElements boolean &lt;optional&gt; If true, the common elements used in most toolbar groups will be added to the children list. These elements are a spacer in the beginning and at the end of the header, the undo and redo buttons, and the eraser button. In the example below you can see these elements being added. By default, the value will be false and these elements will not be added. Example WebViewer(...) .then(function(instance) { const { annotationManager, documentViewer } = instance.Core; const annotHistoryManager = documentViewer.getAnnotationHistoryManager(); // In case you want to use the Toolbar Group label with translation, you can // set the values with the setTranslations API and use the translation key // as the name parameter instance.UI.setTranslations('en', { 'option.toolbarGroup.draw': 'Draw' } ); instance.UI.createToolbarGroup( { name: 'option.toolbarGroup.draw', dataElementSuffix: 'Draw', useDefaultElements: false, children: [ { type: 'spacer' }, { type: 'toolGroupButton', toolGroup: 'freeHandTools', dataElement: 'freeHandToolGroupButton', title: 'annotation.freehand' }, { type: 'toolGroupButton', toolGroup: 'ellipseAreaTools', dataElement: 'ellipseAreaToolGroupButton', title: 'annotation.areaMeasurement' }, { type: 'toolGroupButton', toolGroup: 'rectangleTools', dataElement: 'shapeToolGroupButton', title: 'annotation.rectangle' }, { type: 'divider'}, // Undo Button { type: 'actionButton', style: { 'marginLeft': '0px' }, dataElement: 'undoButton', title: 'action.undo', img: 'icon-operation-undo', onClick: () =&gt; { annotHistoryManager.undo(); }, isNotClickableSelector: () =&gt; !annotHistoryManager.canUndo() }, // Redo Button { type: 'actionButton', dataElement: 'redoButton', title: 'action.redo', img: 'icon-operation-redo', onClick: () =&gt; { annotHistoryManager.redo(); }, isNotClickableSelector: () =&gt; !annotHistoryManager.canRedo() }, { type: 'toolButton', toolName: 'AnnotationEraserTool' }, { type: 'spacer', hidden: ['tablet', 'mobile', 'small-mobile'] } ] }) } }) &lt;static&gt; dangerouslySetNoteTransformFunction(noteTransformFunction) Accepts a function that will be called every time a note in the left panel is rendered. This function can be used to add, edit or hide the contents of the note. Please carefully read the documentation and the notes below before using this API This API is experimental and should be used sparingly. If you find you are heavily relying on this function, it is recommended that you fork the UI repo and make the changes directly in the source code (Note.js). The structure of the HTML that is passed into this function may change may change without notice in any release. Please make sure to test this function thoroughly when upgrading WebViewer versions. There may be unexpected behaviour when using this API. The HTML that is provided is controlled by React, and sometimes React will override any changes you make. If you find any unexpected behaviour when using this API, then this API probably won't work for your use case and you will have to make the changes directly in the source code. Do not use document.createElement to create DOM elements. Instead, use the provided `createElement` utility function provided as the third parameter. Do not use HTMLElement.removeChild or any other APIs that remove elements from the DOM. Doing so will cause React to lose reference to this node, and will crash. If you need to hide an HTML element, set the style to `display: none` instead. Parameters: Name Type Description noteTransformFunction UI.NoteTransformFunction The function that will be used to transform notes in the left panel Example Webviewer(...) .then(instance =&gt; { instance.UI.dangerouslySetNoteTransformFunction((wrapper, state, createElement) =&gt; { // Change the title of every note wrapper.querySelector('.author-and-time&gt;span').innerHTML = 'My custom note title'; // Add a button that alerts the user when clicked const button = createElement('button'); button.onmousedown = (e) =&gt; { if(state.isSelected) { alert('Hello world!'); } else { alert('Goodbye world!'); } }; button.innerHTML = 'Alert me' wrapper.appendChild(button); // Add a button that makes the annotation blue const button = createElement('button'); button.onmousedown = (e) =&gt; { state.annotation.StrokeColor = new instance.Annotations.Color(0, 0, 255); instance.UI.annotManager.redrawAnnotation(state.annotation) }; button.innerHTML = 'Make me blue' wrapper.appendChild(button); }) }); &lt;static&gt; disableClearSearchOnPanelClose() Disable clearing search results when user closes search panel. When disabled, search results are kept even if user closes and reopens search panel. Note, mobile devices never clear search results even if this setting is enabled. This is because the panel needs to be closed to view the search results on the document. Example WebViewer(...) .then(function(instance) { instance.UI.disableClearSearchOnPanelClose(); }); &lt;static&gt; disableDesktopOnlyMode() Disables desktop only mode on WebViewer UI. This means that at small browser width/height, mobile/tablet CSS styling will be applied. Example WebViewer(...) .then(function(instance) { instance.UI.disableDesktopOnlyMode(); }); &lt;static&gt; disableElements(dataElements) Unmount multiple elements in the DOM. Note that this ONLY removes the DOM elements without disabling related features. Parameters: Name Type Description dataElements Array.&lt;string&gt; Array of data-element attribute values for DOM elements. To find data-element of a DOM element, refer to Finding data-element attribute values. Examples WebViewer(...) .then(function(instance) { // remove left panel and left panel button from the DOM instance.UI.disableElements([ 'leftPanel', 'leftPanelButton' ]); }); WebViewer(...) .then(function(instance) { // remove the 'Edit' toolbar group instance.UI.disableElements(['toolbarGroup-Edit']); }); &lt;static&gt; disableFadePageNavigationComponent() Always keep the Page Navigation Component on screen. Default behaviour is to fade it after certain period of inactivity. Example WebViewer(...) .then(function(instance) { // Keeps the page navigation component on screen all the time instance.UI.disableFadePageNavigationComponent(); }); &lt;static&gt; disableFeatures(features) Disable certain features in the WebViewer UI. Parameters: Name Type Description features Array.&lt;string&gt; Array of features to disable. See: UI.Feature Example WebViewer(...) .then(function(instance) { instance.UI.disableFeatures(instance.Feature.Measurement); }); &lt;static&gt; disableHighContrastMode() Turns high contrast mode off. Example WebViewer(...) .then(function(instance) { instance.UI.disableHighContrastMode(); }); &lt;static&gt; disableNativeScrolling() Disable native mobile device scrolling behavior if it had previously been enabled. Note that native mobile device scrolling behavior is off by default. Example WebViewer(...) .then(function(instance) { UI.disableNativeScrolling(); }); &lt;static&gt; disableNoteSubmissionWithEnter() Disable the ability to submit notes by only pressing Enter if it had previously been enabled. This will revert note submission to the default which is Ctrl/Cmd + Enter. Example WebViewer(...) .then(function(instance) { instance.UI.disableNoteSubmissionWithEnter(); }); &lt;static&gt; disablePageDeletionConfirmationModal() Disable the confirmation modal when deleting a page from the thumbnail view Example WebViewer(...) .then(function(instance) { instance.UI.disablePageDeletionConfirmationModal(); }); &lt;static&gt; disableReplyForAnnotations(isReplyDisabledCallback) Disable reply for annotations if the callback function returns true. The callback function gets evaluated when the Comments panel is open, an annotation is selected, and the selected annotation has a comment. Only one callback function will be stored and invoked. If multiple criteria is needed to disable replies you must write them in a single callback function. Parameters: Name Type Description isReplyDisabledCallback UI.disableReplyForAnnotationsCallback Callback function that returns true if reply will be disabled for the annotation passed in. False otherwise. Example WebViewer(...) .then(instance =&gt; { // disable reply for Freehand annotations instance.UI.disableReplyForAnnotations((annotation) =&gt; { return annotation instanceof instance.Annotations.FreeHandAnnotation; }); // disable reply for annotations authored by Guest instance.UI.disableReplyForAnnotations((annotation) =&gt; { return annotation['Author'] === 'Guest'; }); // disable reply for annotations created more than 10 seconds ago instance.UI.disableReplyForAnnotations((annotation) =&gt; { const createdDate = new Date(annotation['DateCreated']); const todayDate = new Date(); return (todayDate - createdDate) &gt; 10000; }); }); &lt;static&gt; disableToolDefaultStyleUpdateFromAnnotationPopup() Disables syncing of annotation style updates to the associated tool that created the annotation. So if an annotation's style is changed the tool default styles will not be updated. Example WebViewer(...) .then(function(instance) { instance.UI.disableToolDefaultStyleUpdateFromAnnotationPopup(); }); &lt;static&gt; disableTools( [toolNames]) Disable multiple tools. This API uses disableElements internally to remove tool buttons from the DOM, and also disable the corresponding hotkeys. Parameters: Name Type Argument Default Description toolNames Array.&lt;string&gt; | Array.&lt;Core.Tools.ToolNames&gt; &lt;optional&gt; all tools Array of name of the tools, either from tool names list or the name you registered your custom tool with. If nothing is passed, all tools will be disabled. Example WebViewer(...) .then(function(instance) { const { Tools } = instance.Core; // disable sticky annotation tool and free text tool instance.UI.disableTools([Tools.ToolNames.STICKY, Tools.ToolNames.FREETEXT]); }); &lt;static&gt; displayErrorMessage(message) Displays the custom error message Parameters: Name Type Description message string An error message Example WebViewer(...) .then(function(instance) { instance.UI.displayErrorMessage('My error message'); }); &lt;static&gt; dispose() Cleans up listeners and data from the WebViewer instance. Should be called when removing the WebViewer instance from the DOM. Returns: A promise that resolves when disposing has been completed Type Promise.&lt;void&gt; Example webViewerInstance.UI.dispose() &lt;static&gt; downloadPdf( [options]) Downloads the pdf document with or without annotations added by WebViewer UI. Parameters: Name Type Argument Description options object &lt;optional&gt; An object that contains the following download options. Properties Name Type Argument Default Description filename string &lt;optional&gt; The filename of the downloaded document. downloadType string &lt;optional&gt; 'pdf' The type to download the file as, by default this is \"pdf\". PDF and image files can only be downloaded as PDFs, but office files can be downloaded as \"pdf\" or as \"office\" if you want to get the original file without annotations. xfdfString string &lt;optional&gt; An xfdf string containing annotation data to be used when downloading. Use this option instead of `includeAnnotations` if not all annotations need to be contained in the downloaded file. includeAnnotations boolean &lt;optional&gt; true Whether or not to include annotations added by WebViewer UI. flatten boolean &lt;optional&gt; Whether or not to flatten all the annotations in the downloaded document. Only useful fullAPI is enabled and either `xfdfString` or `includeAnnotations` is used. documentToBeDownloaded Core.Document &lt;optional&gt; A document to be download instead of the one loaded by Document Viewer. useDisplayAuthor boolean &lt;optional&gt; Whether to export annotations with the Display Author name from annotationManager.getDisplayAuthor() flags number &lt;optional&gt; Core.SaveOptions.REMOVE_UNUSED The flags with which to save the document. Possible values include `Core.SaveOptions.REMOVE_UNUSED` (remove unused objects during save) and `Core.SaveOptions.LINEARIZED` (optimize the document for fast web view and remove unused objects). Returns: A promise that is resolved once the document is downloaded. Type Promise.&lt;any&gt; Example WebViewer(...) .then(async function(instance) { const docViewer = instance.Core.documentViewer; const annotManager = instance.Core.annotationManager; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', async function() { // download pdf without annotations added by WebViewer UI await instance.UI.downloadPdf({ includeAnnotations: false, }); console.log('Downloaded the first time!') // download pdf with all annotations flattened await instance.UI.downloadPdf({ includeAnnotations: true, flatten: true, }); console.log('Downloaded a second time!') // download pdf without links const xfdfString = await annotManager.exportAnnotations({ links: false }); await instance.UI.downloadPdf({ xfdfString: xfdfString, }); console.log('Downloaded a third time!') }); }); &lt;static&gt; enableClearSearchOnPanelClose() Enable clearing search results when user closes search panel. When this is enabled and user closes search panel all search results are cleared. Note, mobile devices never clear search results even if this setting is enabled. This is because the panel needs to be closed to view the search results on the document. Example WebViewer(...) .then(function(instance) { // Will not affect on mobile devices instance.UI.enableClearSearchOnPanelClose(); }); &lt;static&gt; enableDesktopOnlyMode() Enables desktop only mode on WebViewer UI. This means that at small browser width/height, mobile/tablet CSS styling will not be applied. Example WebViewer(...) .then(function(instance) { instance.UI.enableDesktopOnlyMode(); }); &lt;static&gt; enableElements(dataElements) Remount the hidden elements in the DOM. Parameters: Name Type Description dataElements Array.&lt;string&gt; Array of data-element attribute values for DOM elements. To find data-element of a DOM element, refer to Finding data-element attribute values. Example WebViewer(...) .then(function(instance) { // remove left panel and left panel button from the DOM instance.UI.enableElements([ 'leftPanel', 'leftPanelButton' ]); }); &lt;static&gt; enableFadePageNavigationComponent() Fade the Page Navigation Component after it has not been interacted with. Reappears whenever the document is scrolled. Example WebViewer(...) .then(function(instance) { // Sets behaviour to fade the page navigation component. // enabled by default instance.UI.enableFadePageNavigationComponent(); }); &lt;static&gt; enableFeatures(features) Enable certain features in the WebViewer UI. Parameters: Name Type Description features Array.&lt;string&gt; Array of features to enable. See: UI.Feature Example WebViewer(...) .then(function(instance) { instance.UI.enableFeatures(instance.Feature.Measurement); }); &lt;static&gt; enableHighContrastMode() Turns high contrast mode on to help with accessibility. Example WebViewer(...) .then(function(instance) { instance.UI.enableHighContrastMode(); }); &lt;static&gt; enableNativeScrolling() Enable native mobile device scrolling behavior. By default custom behavior is used to handle vertical and horizontal scroll locking. Example WebViewer(...) .then(function(instance) { instance.UI.enableNativeScrolling(); }); &lt;static&gt; enableNoteSubmissionWithEnter() Enable the ability to submit notes by only pressing Enter. Default mode is Ctrl/Cmd + Enter. Example WebViewer(...) .then(function(instance) { instance.UI.enableNoteSubmissionWithEnter(); }); &lt;static&gt; enablePageDeletionConfirmationModal() Enable the confirmation modal when deleting a page from the thumbnail view Example WebViewer(...) .then(function(instance) { instance.UI.enablePageDeletionConfirmationModal(); }); &lt;static&gt; enableToolDefaultStyleUpdateFromAnnotationPopup() Enables syncing of annotation style updates to the associated tool that created the annotation. Note that this is enabled by default. Example WebViewer(...) .then(function(instance) { instance.UI.enableToolDefaultStyleUpdateFromAnnotationPopup(); }); &lt;static&gt; enableTools( [toolNames]) Enable multiple tools. Parameters: Name Type Argument Default Description toolNames Array.&lt;string&gt; &lt;optional&gt; all tools Array of name of the tools, either from tool names list or the name you registered your custom tool with. If nothing is passed, all tools will be enabled. Example WebViewer(...) .then(function(instance) { // enable sticky annotation tool and free text tool instance.UI.enableTools([ 'AnnotationCreateSticky', 'AnnotationCreateFreeText' ]); }); &lt;static&gt; exportBookmarks() Returns a dictionary with page indices as keys and the bookmark text as the values Returns: A dictionary with page indices as keys and the bookmark text as the values. ex: {\"0\":\"Bookmark 1\",\"2\":\"Bookmark 2\"} Type Object Example WebViewer(...) .then(function(instance) { // Save the annotation data for doc123 const bookmarks = instance.UI.exportBookmarks(); const bookmarksString = JSON.stringify(bookmarks); fetch('/server/bookmarksHandler.js?documentId=doc123', { method: 'POST', body: bookmarksString // written into a json file on server }); }); &lt;static&gt; extractPagesWithAnnotations(pageNumbersToExtract) Extract pages from the current document Parameters: Name Type Description pageNumbersToExtract Array.&lt;number&gt; An array of pages to extract from the document. Annotations on the pages are included Returns: A promise that resolve to a File object Type Promise.&lt;File&gt; Example // 6.0 and after WebViewer(...) .then(function(instance) { instance.UI.extractPagesWithAnnotations ([1,2,3]).then(function(fileData){ }); }); &lt;static&gt; focusNote(annotationId) Focuses a note input field for the annotation. If the notes panel is closed, it is automatically opened before focusing. Parameters: Name Type Description annotationId string Id of an annotation. Example WebViewer(...) .then(function(instance) { var annotManager = instance.Core.annotationManager; annotManager.addEventListener('annotationChanged', function(annotations, action) { annotations.forEach(function(annotation) { // Focus the note when annotation is created if (action === 'add' &amp;&amp; annotation.Listable) { instance.UI.focusNote(annotation.Id); // note it is a capital i } }); }); }); &lt;static&gt; getAnnotationReadState(annotationId) Return the read/unread state of an annotation. True for read, false for unread. Parameters: Name Type Description annotationId string Id of the annotation. Throws: Will throw an error if the annotation with the given ID does not exist. Returns: Whether the annotation is read. Type boolean Example WebViewer(...) .then(function(instance) { const isAnnotationRead = instance.UI.getAnnotationReadState('test-annotation-id'); &lt;static&gt; getAvailableLanguages() Returns all available languages as a list. Returns: All available languages Type Array.&lt;string&gt; Example WebViewer(...) .then(function(instance) { console.log(instance.UI.getAvailableLanguages()); }); &lt;static&gt; getCustomData() A getter that returns a stringified version of the 'custom' property that is passed to the WebViewer constructor Refer to the passing custom data section. Returns: returns a stringified version of the 'custom' property that is passed to the WebViewer constructor Type string &lt;static&gt; getFitMode() Return the current fit mode of the WebViewerInstance UI. Returns: Current fit mode Type string Example WebViewer(...) .then(function(instance) { var docViewer = instance.Core.documentViewer; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { console.log(instance.UI.getFitMode()); }); }); &lt;static&gt; getIsHighContrastMode() Check whether high contrast mode is enabled or not. Deprecated: since version 8.0. Use isHighContrastModeEnabled Instead Example WebViewer(...) .then(function(instance) { instance.UI.getIsHighContrastMode(); }); &lt;static&gt; getLayoutMode() Return the current layout mode of the WebViewerInstance. Returns: Current layout mode Type string Example WebViewer(...) .then(function(instance) { var docViewer = instance.Core.documentViewer; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { console.log(instance.UI.getLayoutMode()); }); }); &lt;static&gt; getMaxZoomLevel() Return the max zoom level Returns: max zoom level Type number Example WebViewer(...) .then(function(instance) { const docViewer = instance.Core.documentViewer; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { console.log(instance.UI.getMaxZoomLevel()); }); }); &lt;static&gt; getMinZoomLevel() Return the min zoom level Returns: min zoom level Type number Example WebViewer(...) .then(function(instance) { const docViewer = instance.Core.documentViewer; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { console.log(instance.UI.getMinZoomLevel()); }); }); &lt;static&gt; getSelectedThumbnailPageNumbers() Get the currently selected pages Returns: an array of select page numbers Type Array.&lt;number&gt; Example // 6.0 and after WebViewer(...) .then(function(instance) { instance.UI.getSelectedThumbnailPageNumbers(); }); &lt;static&gt; getToolMode() Return the current tool object. Returns: Instance of the current tool Type Core.Tools.Tool Example WebViewer(...) .then(function(instance) { console.log(instance.UI.getToolMode().name, instance.UI.getToolMode()); }); &lt;static&gt; getWatermarkModalOptions() Gets the watermark options created in print modal. Returns: Returns the watermark options created in print modal. Type object &lt;static&gt; getZoomLevel() Return the current zoom level Returns: Zoom level (0 ~ 1) Type number Example WebViewer(...) .then(function(instance) { const docViewer = instance.Core.documentViewer; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { console.log(instance.UI.getZoomLevel()); }); }); &lt;static&gt; hideOutlineControl() hide outline control Example WebViewer(...) .then(function(instance) { instance.UI.hideOutlineControl(); }); &lt;static&gt; importBookmarks(bookmarks) Imports user bookmarks Parameters: Name Type Description bookmarks object A dictionary with page indices as keys and the bookmark text as the values. ex: {\"0\":\"Bookmark 1\",\"2\":\"Bookmark 2\"}. Behaviour is undefined otherwise. Example WebViewer(...) .then(function(instance) { // load the user bookmarks data for id 'doc123' fetch('/server/bookmarksHandler.js?documentId=doc123', { method: 'GET' }).then(function(response) { if (response.status === 200) { response.text().then(function(bookmarksString) { // {\"0\":\"Bookmark 1\",\"2\":\"Bookmark 2\"} const bookmarks = JSON.parse(bookmarksString); instance.UI.importBookmarks(bookmarks); }); } }); }); &lt;static&gt; isElementDisabled(dataElement) Returns whether the element is disabled. Parameters: Name Type Description dataElement string data-element attribute value for a DOM element. To find data-element of a DOM element, refer to Finding data-element attribute values. Returns: Whether the element is disabled. Type boolean Example WebViewer(...) .then(function(instance) { console.log(instance.UI.isElementDisabled('leftPanel')); }); &lt;static&gt; isElementOpen(dataElement) Returns whether the element is open. Parameters: Name Type Description dataElement string data-element attribute value for a DOM element. To find data-element of a DOM element, refer to Finding data-element attribute values. Returns: Whether the element is open. Type boolean Example WebViewer(...) .then(function(instance) { console.log(instance.UI.isElementOpen('leftPanel')); }); &lt;static&gt; isFullscreen() Returns whether in fullscreen mode. Returns: Whether in fullscreen mode. Type boolean Example WebViewer(...) .then(function(instance) { console.log(instance.UI.isFullscreen()); }); &lt;static&gt; isHighContrastModeEnabled() Check whether high contrast mode is enabled or not. Example WebViewer(...) .then(function(instance) { instance.UI.isHighContrastModeEnabled(); }); &lt;static&gt; isInDesktopOnlyMode() Returns a boolean to denote if the UI is in desktop only mode. Returns: boolean to denote if the UI is in desktop only mode Type boolean Example WebViewer(...) .then(function(instance) { instance.UI.isInDesktopOnlyMode(); }); &lt;static&gt; isToolDisabled(toolName) Returns whether the tool is disabled. Parameters: Name Type Description toolName string Name of the tool, either from tool names list or the name you registered your custom tool with. Returns: Whether the tool is disabled. Type boolean Example WebViewer(...) .then(function(instance) { console.log(instance.UI.isToolDisabled()); }); &lt;static&gt; loadDocument(documentPath [, options]) Load a document inside WebViewer UI. Parameters: Name Type Argument Description documentPath string | File | Blob | Core.Document | Core.PDFNet.PDFDoc Path to the document OR File object if opening local file. options UI.loadDocumentOptions &lt;optional&gt; Additional options Example WebViewer(...) .then(function(instance) { instance.UI.loadDocument('https://www.pdftron.com/downloads/pl/test.pdf', { documentId: '1', filename: 'sample-1.pdf' }); }); &lt;static&gt; openElements(dataElements) Sets visibility states of the elements to be visible. Note that openElements works only for panel/overlay/popup/modal elements. Parameters: Name Type Description dataElements Array.&lt;string&gt; Array of data-element attribute values for DOM elements. To find data-element of a DOM element, refer to Finding data-element attribute values. Example WebViewer(...) .then(function(instance) { // opens (shows) text popup and annotation popup in the UI instance.UI.openElements([ 'menuOverlay', 'leftPanel' ]); }); &lt;static&gt; overrideSearchExecution(overrideSearchExecutionCallback) Add custom override function for default search on UI. overrideSearchExecutionCallback function will be executed with search value and search options when user executes search from UI. This function won't be executed when search is triggered through programmatic searches. Parameters: Name Type Description overrideSearchExecutionCallback function Function that will executed instead of default search functionality. Example WebViewer(...) .then(function(instance) { function searchFn(searchValue, options) { console.log(searchValue, options); }; instance.UI.overrideSearchExecution(searchFn); }); &lt;static&gt; print() Print the current document. Example WebViewer(...) .then(function(instance) { const docViewer = instance.Core.documentViewer; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { instance.UI.print(); }); }); &lt;static&gt; printInBackground( [options]) Programmatically print the document without opening a modal with the print options provided. Not supported by legacy-ui Parameters: Name Type Argument Description options object &lt;optional&gt; Options for the printing. Properties Name Type Argument Default Description pagesToPrint Array.&lt;number&gt; &lt;optional&gt; Optionally pass in the pages you want to print. By default, all pages will be printed. includeAnnotations boolean &lt;optional&gt; false If true, will print the documents with the annotations includeComments boolean &lt;optional&gt; false If true, will append comments to the document printed isPrintCurrentView boolean &lt;optional&gt; If true, will print the current viewport view of the current page maintainPageOrientation boolean &lt;optional&gt; If true, will maintain the pages orientation as set in the webviewer during printing onProgress function &lt;optional&gt; A callback function that is executed on each page processed Example WebViewer(...) .then(function(instance) { const docViewer = instance.Core.documentViewer; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { instance.UI.printInBackground({ includeComments:true, includeAnnotations: true, maintainPageOrientation: true, onProgress: function(pageNumber, htmlElement) {}, }); }); }); &lt;static&gt; registerTool(properties [, annotationConstructor] [, customAnnotationCheckFunc]) Registers tool in the document viewer tool mode map, and adds a button object to be used in the header. See Customizing tools to learn how to make a tool. Parameters: Name Type Argument Description properties object Tool properties. Properties Name Type Argument Description toolName string Name of the tool. toolObject Core.Tools.Tool Instance of the tool. buttonImage string Path to an image or base64 data for the tool button. buttonName string &lt;optional&gt; Name of the tool button that will be used in data-element. buttonGroup string &lt;optional&gt; Group of the tool button belongs to. tooltip string &lt;optional&gt; Tooltip of the tool button. showColor 'always' | 'active' | 'never' &lt;optional&gt; Controls when the tool button should show the color. showPresets boolean &lt;optional&gt; Option to whether show or hide preset styles. Default is true. annotationConstructor function &lt;optional&gt; Deprecated Please use customAnnotationCheckFunc instead. Will be removed in the future. customAnnotationCheckFunc function &lt;optional&gt; Function that takes in a parameter of an annotation. Returns a boolean if the specified annotation is a certain type of annotation. This function is used by the viewer to check if the annotation passed in is associated(created) with the registered tool. Example WebViewer(...) .then(function(instance) { // assume myCustomTool and myCustomAnnotation are already defined const myTool = { toolName: 'MyTool', toolObject: myCustomTool, buttonImage: 'path/to/image', buttonName: 'myToolButton', buttonGroup: 'miscTools', tooltip: 'MyTooltip' }; instance.UI.registerTool(myTool, undefined, annot =&gt; annot &amp;&amp; annot.isCustomAnnot); }); &lt;static&gt; reloadOutline() Reloads the Bookmark Outline in the WebViewer UI. Example WebViewer(...) .then(function(instance) { const { documentViewer } = instance.Core; // you must have a document loaded when calling this api documentViewer.addEventListener('documentLoaded', async () =&gt; { const doc = documentViewer.getDocument(); const pdfDoc = await doc.getPDFDoc(); const firstBookmark = await doc.getFirstBookmark(); const bookmarkToDelete = await firstBookmark.find('bookmark-to-delete'); if (bookmarkToDelete !== null &amp;&amp; await bookmarkToDelete.isValid()) { await bookmarkToDelete.delete(); instance.UI.reloadOutline(); } }); }); &lt;static&gt; removeEventListener(eventName, listener) \"Remove an event listener for the given WebViewer UI event. Parameters: Name Type Description eventName string UI event name. listener function Event handler function that should no longer be bound to the event. Example WebViewer(...) .then(function(instance) { const listener = e =&gt; { const { types, authors, colors } = e.detail; console.log(types, authors, colors); instance.UI.removeEventListener(instance.UI.Events.ANNOTATION_FILTER_CHANGED, listener); }; instance.UI.addEventListener(instance.UI.Events.ANNOTATION_FILTER_CHANGED, listener); }); &lt;static&gt; removeRedactionSearchPattern(searchPattern) Removes a search pattern from the redaction search panel Parameters: Name Type Description searchPattern UI.RedactionSearchPatterns | string A search pattern to remove from the redaction search panel. If you added a custom search pattern with UI.addRedactionSearchPattern, you must pass the type of the search pattern you added. Example WebViewer(...) .then(function(instance) { instance.UI.removeRedactionSearchPattern(instance.UI.RedactionSearchPatterns.EMAILS); }); // If you added a custom search pattern for Social Security Number where the type is 'socialSecurityNumber'. WebViewer(...) .then(function(instance) { instance.UI.removeRedactionSearchPattern('socialSecurityNumber'); }); &lt;static&gt; removeSearchListener(listener) Removes the search listener function. Parameters: Name Type Description listener UI.searchListener Search listener function that was added. Example WebViewer(...) .then(function(instance) { function searchListener(searchValue, options, results) { console.log(searchValue, options, results); }; instance.UI.addSearchListener(searchListener); instance.UI.removeSearchListener(searchListener); }); &lt;static&gt; replaceRedactionSearchPattern(searchPattern, regex) Sets a specific regex to be used when searching for one of the supported patterns in the redaction search panel Parameters: Name Type Description searchPattern UI.RedactionSearchPatterns A search pattern for which the regex should be replaced regex string The regex to be used for the search pattern Example WebViewer(...) .then(function(instance) { instance.UI.replaceRedactionSearchPattern(instance.UI.RedactionSearchPatterns.EMAILS, /\\w+@\\w+\\.\\w+/); }); &lt;static&gt; searchText(searchValue [, options]) Searches the document one by one for the text matching searchValue. To go to the next result this function must be called again. Once document end is reach it will jump back to the first found result. Parameters: Name Type Argument Description searchValue string The text value to look for. options object &lt;optional&gt; Search options. Properties Name Type Argument Default Description caseSensitive boolean &lt;optional&gt; false Search with matching cases. wholeWord boolean &lt;optional&gt; false Search whole words only. wildcard boolean &lt;optional&gt; false Search a string with a wildcard *. For example, *viewer. regex boolean &lt;optional&gt; false Search for a regex string. For example, www(.*)com. searchUp boolean &lt;optional&gt; false Search up the document (backwards). ambientString boolean &lt;optional&gt; false Get the ambient string in the result. Example WebViewer(...) .then(function(instance) { const docViewer = instance.Core.documentViewer; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { instance.UI.searchText('test', { caseSensitive: true, wholeWord: true }); }); }); &lt;static&gt; searchTextFull(searchValue [, options]) Searches the full document for the texts matching searchValue. Parameters: Name Type Argument Description searchValue string The text value to look for. options object &lt;optional&gt; Search options. Properties Name Type Argument Default Description caseSensitive boolean &lt;optional&gt; false Search with matching cases. wholeWord boolean &lt;optional&gt; false Search whole words only. wildcard boolean &lt;optional&gt; false Search a string with a wildcard *. For example, *viewer. regex boolean &lt;optional&gt; false Search for a regex string. For example, www(.*)com. Example WebViewer(...) .then(function(instance) { const docViewer = instance.Core.documentViewer; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { instance.UI.searchTextFull('test', { wholeWord: true }); }); }); &lt;static&gt; selectThumbnailPages(pageNumbers) Select thumbnails in the thumbnail panel. This requires the \"ThumbnailMultiselect\" feature to be enabled Parameters: Name Type Description pageNumbers Array.&lt;number&gt; array of page numbers to select Example // 6.1 and after WebViewer(...) .then(function(instance) { instance.UI.enableFeatures(['ThumbnailMultiselect']); const pageNumbersToSelect = [1, 2, 3]; instance.UI.selectThumbnailPages(pageNumbersToSelect); }); &lt;static&gt; setActiveHeaderGroup(headerGroup) Sets a header group to be rendered in the Header element. This API comes useful when replacing the entire header items in small screens. Parameters: Name Type Description headerGroup string Name of the header group to be rendered. Default WebViewer UI has eight header groups: 'default', 'small-mobile-more-buttons', 'toolbarGroup-View', 'toolbarGroup-Annotate', 'toolbarGroup-Shapes', 'toolbarGroup-Insert', 'toolbarGroup-Measure', and 'toolbarGroup-Edit'. Example WebViewer(...) .then(function(instance) { instance.UI.setActiveHeaderGroup('toolbarGroup-Annotate'); // switch to 'Annotate' group header }); &lt;static&gt; setActiveLeftPanel(dataElement) Sets a panel to be active in the leftPanel element. Note that this API does not include opening the leftPanel. Parameters: Name Type Description dataElement string Name of the panel to be active in leftPanel. Default WebViewer UI has three panel options: thumbnailsPanel, outlinesPanel and notesPanel. Example WebViewer(...) .then(function(instance) { // open left panel instance.UI.openElements([ 'leftPanel' ]); // view outlines panel instance.UI.setActiveLeftPanel('outlinesPanel'); &lt;static&gt; setActivePalette(toolName, colorPalette) Sets the active color palette of a tool and its associated annotation Parameters: Name Type Description toolName string Name of the tool, either from tool names list or the name you registered your custom tool with. colorPalette 'text' | 'border' | 'fill' The palette to be activated. One of 'text', 'border' and 'fill'. Example WebViewer(...) .then(function(instance) { instance.UI.setActivePalette('AnnotationCreateFreeText', 'fill') }); &lt;static&gt; setAnnotationContentOverlayHandler(customOverlayHandler) Adds a custom overlay to annotations on mouseHover, overriding the existing overlay. Parameters: Name Type Description customOverlayHandler function A function that takes an annotation and returns a DOM Element, which is rendered as a tooltip when hovering over the annotation. Returning null or false will render nothing. Returning 'undefined' will use default behavior. Example WebViewer(...) .then(function(instance) { instance.UI.setAnnotationContentOverlayHandler(annotation =&gt; { const div = document.createElement('div'); div.appendChild(document.createTextNode(`Created by: ${annotation.Author}`)); div.appendChild(document.createElement('br')); div.appendChild(document.createTextNode(`Created on ${annotation.DateCreated}`)); return div; }); }); &lt;static&gt; setAnnotationReadState(options) Set the read/unread state of an annotation. The default state of annotations is read. Parameters: Name Type Description options object Properties Name Type Description isRead boolean whether setting the annotation to read state; false for setting it as unread. annotationId string Id of the annotation to be set. Example WebViewer(...) .then(function(instance) { instance.UI.setAnnotationReadState({ isRead: true, annotationId: 'test-annotation-id' }); }); &lt;static&gt; setColorPalette(An) Sets the colors in the palette globally or for specific tools and their associated annotations Parameters: Name Type Description An Array.&lt;string&gt; | UI.PaletteOption array of hex colors that will override the default colors for every tool. An object can be passed to specify colors for particular tools. Example WebViewer(...) .then(function(instance) { // this sets the palette globally. All the tools will use these colors. Can use empty string for blank spaces and 'transparency' for a transparent color. instance.UI.setColorPalette(['#FFFFFF', '', '#DDDDDD', 'transparency']); // use a different set of colors for the freetext and rectangle tool. instance.UI.setColorPalette({ toolNames: ['AnnotationCreateFreeText', 'AnnotationCreateRectangle'], colors: ['#333333'], }) }); &lt;static&gt; setCustomApplyRedactionsHandler(customApplyRedactionsHandler) Parameters: Name Type Description customApplyRedactionsHandler UI.CustomApplyRedactionsHandler The function that will be invoked when clicking on the 'Redact All' button. Example WebViewer(...) .then(function(instance) { instance.UI.setCustomApplyRedactionsHandler((annotationsToRedact, originalApplyRedactionsFunction) =&gt; { // custom code ... originalApplyRedactionsFunction(); }) }); &lt;static&gt; setCustomMeasurementOverlay(customOverlayInfo) Adds a custom overlay to annotations if that annotation currently support it. Currently only the Ellipsis annotation supports it. Parameters: Name Type Description customOverlayInfo array an array of customOverlay configurations. The configuration object has five properties: title, label, validate, value, and onChange Example WebViewer(...) .then(function(instance) { instance.UI.setCustomMeasurementOverlayInfo([ { title: \"Radius Measurement\", //Title for overlay label: \"Radius\", // Label to be shown for the value // Validate is a function to validate the annotation is valid for the current custom overlay validate: annotation =&gt; annotation instanceof instance.Annotations.EllipseAnnotation, // The value to be shown in the custom overlay value: annotation =&gt; annotation.Width / 2, // onChange will be called whenever the value in the overlay changes from user input onChange: (e, annotation) =&gt; { // Do something with the annot like resize/redraw instance.Core.annotationManager.redrawAnnotation(annotation); } } ]) }); &lt;static&gt; setCustomModal(options) Parameters: Name Type Description options object Properties Name Type Argument Default Description dataElement string Unique name of custom modal. disableBackdropClick boolean &lt;optional&gt; false Disable closing modal when user clicks outside of content area disableEscapeKeyDown boolean &lt;optional&gt; false Disable closing modal when user hit escape from keyboard render UI.renderCustomModal Function rendering custom model contents Deprecated: since version 8.5. Use addCustomModal instead &lt;static&gt; setCustomNoteFilter(filterAnnotation) Filter the annotations shown in the notes panel Parameters: Name Type Description filterAnnotation UI.filterAnnotation Function that takes an annotation and returns if the annotation(note) should be shown in the notes panel. Example WebViewer(...) .then(function(instance) { // only show annotations that are created by John instance.UI.setCustomNoteFilter(function(annotation) { return annotation.Author === 'John'; }); }); &lt;static&gt; setCustomNoteSelectionFunction(customNoteSelectionFunction) Parameters: Name Type Description customNoteSelectionFunction UI.CustomNoteSelectionFunction The function that will be invoked when clicking on a note in notes panel. The function will only be invoked when the underlying annotation is not already selected. Example WebViewer(...) .then(function(instance) { instance.UI.setCustomNoteSelectionFunction(annotation =&gt; { // some code }) }); &lt;static&gt; setCustomPanel(options) Adds a custom panel in left panel Parameters: Name Type Description options object Properties Name Type Description tab object Tab options. Properties Name Type Description dataElement string data-element for tab. title string Tooltip for tab. img string Url for an image. panel object Panel options. Properties Name Type Description dataElement string data-element for panel. render UI.renderCustomPanel Function that returns panel element. Example WebViewer(...) .then(function(instance) { var myCustomPanel = { tab:{ dataElement: 'customPanelTab', title: 'customPanelTab', img: 'https://www.pdftron.com/favicon-32x32.png', }, panel: { dataElement: 'customPanel', render: function() { var div = document.createElement('div'); div.innerHTML = 'Hello World'; return div; } } }; instance.UI.setCustomPanel(myCustomPanel); }); &lt;static&gt; setDefaultPrintOptions(options) Sets the default print options. Parameters: Name Type Description options object The default print options of the document to print. Must be an object. Properties Name Type Argument Description includeComments boolean &lt;optional&gt; Whether or not will print the documents with the comments includeAnnotations boolean &lt;optional&gt; Whether or not will print the documents with the annotations maintainPageOrientation boolean &lt;optional&gt; Whether or not will maintain the pages orientation as set in the webviewer Example WebViewer(...) .then(function(instance) { instance.UI.setDefaultPrintOptions({ includeComments: true, includeAnnotations: true }); }); &lt;static&gt; setDisplayedSignaturesFilter(filterFunction) Accepts a function that filters what saved signatures will be displayed in the signature annotation preset. Changing this function will instantly changes signatures displayed in the preset. Parameters: Name Type Description filterFunction UI.SignatureFilterFunction The function that will be used to filter signatrues displayed in the preset Example Webviewer(...) .then(instance =&gt; { // Only signatures that have a value set for the 'isInitial' custom data property will display in the preset instance.UI.setDisplayedSignaturesFilter((a) =&gt; a.getCustomData('isInitial')); }); &lt;static&gt; setFitMode(fitMode) Sets the fit mode of the viewer. Parameters: Name Type Description fitMode string Fit mode of WebViewer. See: UI.FitMode Example WebViewer(...) .then(function(instance) { var docViewer = instance.Core.documentViewer; var FitMode = instance.UI.FitMode; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { instance.UI.setFitMode(FitMode.FitWidth); }); }); &lt;static&gt; setHeaderItems(headerCallback) Customize header. Refer to Customizing header for details. Parameters: Name Type Description headerCallback UI.headerCallback Callback function to perform different operations on the header. Examples // Adding save annotations button to the end of the top header WebViewer(...) .then(function(instance) { instance.UI.setHeaderItems(function(header) { var myCustomButton = { type: 'actionButton', img: '&lt;svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"&gt;&lt;path d=\"M0 0h24v24H0z\" fill=\"none\"/&gt;&lt;path d=\"M17 3H5c-1.11 0-2 .9-2 2v14c0 1.1.89 2 2 2h14c1.1 0 2-.9 2-2V7l-4-4zm-5 16c-1.66 0-3-1.34-3-3s1.34-3 3-3 3 1.34 3 3-1.34 3-3 3zm3-10H5V5h10v4z\"/&gt;&lt;/svg&gt;', onClick: function() { } } header.push(myCustomButton); }); }); // Removing existing buttons from the top header WebViewer(...) .then(function(instance) { instance.UI.setHeaderItems(function(header) { header.update([]); }); }); // Appending logo to the 'Annotate' toolbar group and shifting existing buttons to the right WebViewer(...) .then(function(instance) { instance.UI.setHeaderItems(function(header) { header.getHeader('toolbarGroup-Annotate').unshift({ type: 'customElement', render: function() { var logo = document.createElement('img'); logo.src = 'https://www.pdftron.com/downloads/logo.svg'; logo.style.width = '200px'; logo.style.marginLeft = '10px'; logo.style.cursor = 'pointer'; logo.onclick = function() { window.open('https://www.pdftron.com', '_blank'); } return logo; } }, { type: 'spacer' }); }); }); // Moving the line tool from the 'Shapes' toolbar group to the 'Annotate' toolbar group WebViewer(...) .then(function(instance) { instance.UI.setHeaderItems(function(header) { header.getHeader('toolbarGroup-Annotate').push({ type: 'toolGroupButton', toolGroup: 'lineTools', dataElement: 'lineToolGroupButton', title: 'annotation.line' }); header.getHeader('toolbarGroup-Shapes').delete(6); }); }); &lt;static&gt; setHighContrastMode(useHighContrastMode) Turns high contrast mode on or off to help with accessibility. Parameters: Name Type Description useHighContrastMode boolean If true then the UI will use high contrast colors to help with accessibility. Deprecated: since version 8.0. Use enableHighContrastMode or disableHighContrastMode Instead Example // Using predefined string WebViewer(...) .then(function(instance) { instance.UI.setHighContrastMode(true); }); &lt;static&gt; setIconColor(toolName, colorPalette) Sets the color palette that will be used as a tool button's icon color. Parameters: Name Type Description toolName string Name of the tool, either from tool names list or the name you registered your custom tool with. colorPalette string The palette which will be used as a tool button's icon color. One of 'text', 'border' and 'fill'. Example WebViewer(...) .then(function(instance) { // sets the color in fill palette to be used as freetext tool button's icon color // by default freetext tool button will use the color in text palette as its icon color instance.UI.setIconColor('AnnotationCreateFreeText', 'fill') }); &lt;static&gt; setLanguage(language) Set the language of WebViewer UI. Parameters: Name Type Description language string The language WebViewer UI will use. By default, following languages are supported: en, zh_cn, fr. Example WebViewer(...) .then(function(instance) { instance.UI.setLanguage('fr'); // set the language to French }); &lt;static&gt; setLayoutMode(layoutMode) Sets the layout mode of the viewer. Parameters: Name Type Description layoutMode string Layout mode of WebViewerInstance UI. See: UI.LayoutMode Example WebViewer(...) .then(function(instance) { const docViewer = instance.Core.documentViewer; const LayoutMode = instance.UI.LayoutMode; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { instance.UI.setLayoutMode(LayoutMode.FacingContinuous); }); }); &lt;static&gt; setMaxSignaturesCount( [maxSignaturesCount]) Set the number of signatures that can be stored in the WebViewer (default is 2) Parameters: Name Type Argument Default Description maxSignaturesCount number &lt;optional&gt; 2 Number of signature webViewer can store Example WebViewer(...) .then(function(instance) { instance.UI.setMaxSignaturesCount(5); // allow up to 5 stored signatures }); &lt;static&gt; setMaxZoomLevel(zoomLevel) Sets the maximum zoom level allowed by the UI. Default is 9999%. Parameters: Name Type Description zoomLevel string | number Zoom level in either number or percentage. Example WebViewer(...) .then(function(instance) { instance.UI.setMaxZoomLevel('150%'); // or setMaxZoomLevel(1.5) }); &lt;static&gt; setMeasurementUnits(units) Sets the units that will be displayed in the measurement tools' styles popup Valid units are: 'mm', 'cm', 'm', 'km', 'mi', 'yd', 'ft', 'in', 'pt' Parameters: Name Type Description units Object an object which contains the from units and to units Example WebViewer(...) .then(function(instance) { instance.UI.setMeasurementUnits({ from: ['in', 'cm', 'm'], to: ['cm', 'm', 'km'] }); }); &lt;static&gt; setMinZoomLevel(zoomLevel) Sets the minimum zoom level allowed by the UI. Default is 5%. Parameters: Name Type Description zoomLevel string | number Zoom level in either number or percentage. Example WebViewer(...) .then(function(instance) { instance.UI.setMinZoomLevel('10%'); // or setMinZoomLevel(0.1) }); &lt;static&gt; setNoteDateFormat(format) Sets the format for displaying the date when a note is create/modified. A list of formats can be found dayjs API. Parameters: Name Type Description format string The format of date to display Example WebViewer(...) .then(function(instance) { instance.UI.setNoteDateFormat('DD.MM.YYYY HH:MM'); }); &lt;static&gt; setNotesPanelSortStrategy(sortStrategy) Sets a sorting algorithm for the Notes Panel. Parameters: Name Type Description sortStrategy string Name of the sort strategy algorithm. Check UI.NotesPanelSortStrategy for the options or use your own strategy. See: UI.NotesPanelSortStrategy Example WebViewer(...) .then(function(instance) { const sortStrategy = instance.UI.NotesPanelSortStrategy; instance.UI.setNotesPanelSortStrategy(sortStrategy.TYPE); // sort notes by type }); &lt;static&gt; setPageLabels(pageLabels) Sets page labels that will be displayed in UI. You may want to use this API if the document's page labels start with characters/numbers other than 1. Parameters: Name Type Description pageLabels Array.&lt;string&gt; Page labels that will be displayed in UI. Example WebViewer(...) .then(function(instance) { var docViewer = instance.Core.documentViewer; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { instance.UI.setPageLabels(['i', 'ii', 'iii', '4', '5']); // assume a document has 5 pages }); }); &lt;static&gt; setPageReplacementModalFileList(list) Add a list of documents to the dropdown element of Page Replacement modal and provide a way to retreive document for displaying Page Replacement modal. Parameters: Name Type Description list Array An array of object for selection element. Object must have \"id\", \"filename\" properties and \"onSelect\" method. Example WebViewer(...) .then(function(instance) { const list = [ {id: '12', filename: 'file-one.pdf'}, {id: '13', filename: 'file-two.pdf'}, {id: '14', filename: 'foobar.pdf'} ]; const options = list.map(item =&gt; { // Add \"onSelect\" method to each item, and return Document instance item.onSelect = () =&gt; instance.Core.createDocument('https://localhost/files/webviewer-demo.pdf'); return item; }); instance.UI.setPageReplacementModalFileList(options); }); &lt;static&gt; setPresetCropDimensions(presetName, newPreset) Sets preset crop dimensions to be used when selecting a preset crop in the document cropping popup Parameters: Name Type Description presetName string The name of a current preset or the name to give to a new preset newPreset object A set of dimensions to use for a preset crop Properties Name Type Description yOffset number The amount of inches to move the cropped area from the top of the page height number The height of the area to crop the page to in inches xOffset number The amount of inches to move the cropped area from the left of the page width number The width of the area to crop the page to in inches Example WebViewer(...) .then(function(instance) { instance.UI.setPresetCropDimensions('Letter', {'yOffset': 0, 'height': 11, 'xOffset': 0, 'width': 8.5}); }); &lt;static&gt; setPrintedNoteDateFormat(format) Sets the format for displaying the date when a note is printed. A list of formats can be found dayjs API. Parameters: Name Type Description format string The format of date to display Example WebViewer(...) .then(function(instance) { instance.UI.setPrintedNoteDateFormat('DD.MM.YYYY HH:MM'); }); &lt;static&gt; setPrintQuality(quality) Sets the print quality. Higher values are higher quality but takes longer to complete and use more memory. The viewer's default quality is 1. Parameters: Name Type Description quality number The quality of the document to print. Must be a positive number. Example WebViewer(...) .then(function(instance) { instance.UI.setPrintQuality(2); }); &lt;static&gt; setSelectedTab(id, dataElement) Sets the currently selected tab of a Tabs component. Parameters: Name Type Description id string The id of the Tabs component to set. dataElement string The 'dataElement' attribute of the TabPanel component to select. Example WebViewer(...) .then(function(instance) { // Set the currently selected tab of 'signatureModal' to be the 'Type' panel. instance.UI.setSelectedTab('signatureModal', 'textSignaturePanelButton'); //'inkSignaturePanelButton', 'imageSignaturePanelButton' // Set the currently selected tab of 'linkModal' to be the 'Page' panel. instance.UI.setSelectedTab('linkModal', 'PageNumberPanelButton'); //'URLPanelButton' // Set the currently selected tab of 'rubberStampTab' to be the 'Custom' panel. instance.UI.setSelectedTab('rubberStampTab', 'customStampPanelButton'); //'standardStampPanelButton' }); &lt;static&gt; setSignatureFonts(fonts) Set the fonts that are used when typing a signature in the signature dialog. Parameters: Name Type Description fonts Array.&lt;string&gt; | UI.setSignatureFontsCallback An array of font families. Example // 6.1 WebViewer(...) .then(function(instance) { instance.UI.setSignatureFonts(['GreatVibes-Regular']); instance.UI.setSignatureFonts(currentFonts =&gt; [ ...currentFonts, 'sans-serif', ]); }); &lt;static&gt; setSwipeOrientation(swipeOrientation) Sets the swipe orientation between pages of WebViewer UI on mobile devices. Default is horizontal. Parameters: Name Type Description swipeOrientation string The swipe orientation to navigate between pages. Available orientations are: horizontal, vertical and both. Example WebViewer(...) .then(function(instance) { instance.UI.setSwipeOrientation('vertical'); // set the swipe orientation to vertical. }); &lt;static&gt; setTheme(theme) Sets the theme of WebViewer UI. Please note that this does not work in IE11. Parameters: Name Type Description theme string Theme of WebViewerInstance UI. See: UI.Theme Example WebViewer(...) .then(function(instance) { const theme = instance.UI.Theme; instance.UI.setTheme(theme.DARK); }); &lt;static&gt; setToolbarGroup(groupDataElement [, pickTool]) Sets the current active toolbar group. Parameters: Name Type Argument Description groupDataElement string The groups dataElement. Default values are: toolbarGroup-View, toolbarGroup-Annotate, toolbarGroup-Shapes, toolbarGroup-Insert, toolbarGroup-Measure, toolbarGroup-Edit, toolbarGroup-Forms pickTool boolean &lt;optional&gt; If true, after setting the toolbar group, the last picked tool for the group will be set as the current tool. Defaults to true. Example WebViewer(...) .then(function(instance) { // Change the toolbar group to the `Shapes` group instance.UI.setToolbarGroup('toolbarGroup-Shapes'); &lt;static&gt; setToolMode(toolName) Sets tool mode. Parameters: Name Type Description toolName string | Core.Tools.ToolNames Name of the tool, either from tool names list or the name you registered your custom tool with. Example WebViewer(...) .then(function(instance) { instance.UI.setToolMode('AnnotationEdit'); }); &lt;static&gt; setTranslations(language, translationObject) Add/Edit translations data for a specific language Parameters: Name Type Description language string The language code for which you want to add/edit translation data translationObject object A key/value object with the new/updated translations Properties Name Type Description key string A key value for the new/updated translation. Refer to the lib/ui/i18n folder to find the existing keys in the translation files value string A value of the new/updated translation Example WebViewer(...) .then(function(instance) { instance.UI.setTranslations('es', { 'option.colorPalette.colorLabel': 'Etiqueta de color', //updates a pre-existing translation data 'action.newButton': 'Nuevo botón' // adds a new translation data }); }); &lt;static&gt; setWv3dPropertiesPanelModelData(modelData) Set the WV3D Properties Panel with an array of model data objects Parameters: Name Type Description modelData array Array of objects defining 3d metadata properties. Example WebViewer(...) .then(function(instance) { instance.UI.setWv3dPropertiesPanelModelData([{'name':'roof', 'height':'55cm'}, {'name':'wall', 'height':'100cm'}]); }); &lt;static&gt; setWv3dPropertiesPanelSchema(schema) Set the configuration schema for the WV3D Properties Panel Parameters: Name Type Description schema object Object containing options for configuring the 3d properties panel. Properties Name Type Description headerName string Sets the Title Header defaultValues object Defines the key/value pairs that will appear under the title, outside of a group. groups object Defines the collapsible groups that appear below the default values. groupOrder array Defines the order of the groups. If a group is not included it is appended to the end of the defined groups. removeEmptyRows boolean Defines whether to remove rows that contain empty string values. removeEmptyGroups boolean Defines whether to remove groups that contain only empty string values. createRawValueGroup boolean Defines whether to create a final group that has all the raw values. Example WebViewer(...) .then(function(instance) { instance.UI.setWv3dPropertiesPanelSchema({ headerName: 'Name', defaultValues: { Description: 'Description', GlobalID: 'GlobalId', Handle: 'handle', EmptyRow1: 'EmptyRow1', }, groups: { SampleGroup01: { SampleField01: 'Sample01', SampleField02: 'Sample02', SampleField03: 'Sample03', EmptyRow2: 'EmptyRow2', GrossFootprintArea: 'GrossFootprintArea', GrossSideArea: 'GrossSideArea', GrossVolume: 'GrossVolume', }, SampleGroup02: { SampleField01: 'Sample01', SampleField02: 'Sample02', SampleField03: 'Sample03', }, SampleGroup03: { ObjectType: 'Elephants', EmptyRow3: 'Tigers', ObjectPlacement: 'Bears', }, }, groupOrder: ['Dimensions', 'RandomStuff'], removeEmptyRows: false, removeEmptyGroups: true, createRawValueGroup: true, }) }); &lt;static&gt; setZoomLevel(zoomLevel) Sets zoom level. Parameters: Name Type Description zoomLevel string | number Zoom level in either number or percentage. Example WebViewer(...) .then(function(instance) { var docViewer = instance.Core.documentViewer; // you must have a document loaded when calling this api docViewer.addEventListener('documentLoaded', function() { instance.UI.setZoomLevel('150%'); // or setZoomLevel(1.5) }); }); &lt;static&gt; showErrorMessage(message) Displays the custom error message Parameters: Name Type Description message string An error message Deprecated: Since version 8.0. Use displayErrorMessage instead. Example WebViewer(...) .then(function(instance) { instance.UI.showErrorMessage('My error message'); }); &lt;static&gt; showOutlineControl() Show outline control Example WebViewer(...) .then(function(instance) { instance.UI.showOutlineControl(); }); &lt;static&gt; showWarningMessage(options) Displays the custom error message Parameters: Name Type Description options string | object Warning string message to display or an object for controlling the warning popup Properties Name Type Description confirmBtnText string The text that will be rendered in the confirm button title string The title of the modal message string The text that will rendered in the body of the modal onConfirm function The callback function that will be invoked when the user clicks the Confirm button. The callback must return a Promise that resolves. onCancel function The callback function that will be invoked when the user clicks the Cancel button. The callback must return a Promise that resolves. Example WebViewer(...) .then(function(instance) { instance.UI.showWarningMessage({ title: 'This is my warning modal title', message: 'This is the body of my modal', confirmBtnText: 'Okay!', onConfirm: () =&gt; { console.log('The user clicked the confirm button'); return Promise.resolve(); }, onCancel: () =&gt; { console.log('The user clicked the cancel button'); return Promise.resolve(); }, }); }); &lt;static&gt; syncNamespaces(namespaces, otherInstances) Syncs the namespaces under the Core namespace for the window, this instance, as well as others instances. This is required for interoperability between multiple instances of WebViewer since each loaded instance ends up with different class references despite sharing the same name. Parameters: Name Type Argument Description namespaces WebViewerInstance | object The object containing the namespaces that will be used for all instances. This can be a WebViewer instance or an object with the namespaces inside. Properties Name Type Argument Description PDFNet object &lt;optional&gt; The PDFNet namespace. This is probably the most common that needs to be synced. Actions object &lt;optional&gt; The Actions namespace. Annotations object &lt;optional&gt; The Annotations namespace. Math object &lt;optional&gt; The Math namespace. Tools object &lt;optional&gt; The Tools namespace. otherInstances WebViewerInstance &lt;repeatable&gt; Other instances that will share the same namespaces. Example // Loaded PDFNet directly const Core = window.Core; const PDFNet = Core.PDFNet; Core.setWorkerPath('../../../lib/core'); Core.enableFullPDF(); ... WebViewer(...) .then(function(instance) { // Force this instance to use the loaded PDFNet instead of the one loaded specific to this instance instance.UI.syncNamespaces({ PDFNet }); // instance.UI.syncNamespaces({ PDFNet }, instance2, instance3); // Alternative; instance, instance2, and instance3 will share the same PDFNet namespace. ... }); &lt;static&gt; toggleElement(dataElement) Toggles a visibility state of the element to be visible/hidden. Note that toggleElement works only for panel/overlay/popup/modal elements. Parameters: Name Type Description dataElement string data-element attribute value for a DOM element. To find data-element of a DOM element, refer to Finding data-element attribute values. Deprecated: Since version 8.0. Use toggleElementVisibility instead. Example WebViewer(...) .then(function(instance) { instance.UI.toggleElement('leftPanel'); // open LeftPanel if it is closed, or vice versa }); &lt;static&gt; toggleElementVisibility(dataElement) Toggles the visibility of the element to be visible/hidden. Note that toggleElementVisibility works only for panel/overlay/popup/modal elements. Parameters: Name Type Description dataElement string data-element attribute value for a DOM element. To find data-element of a DOM element, refer to Finding data-element attribute values. Example WebViewer(...) .then(function(instance) { instance.UI.toggleElementVisibility('leftPanel'); // open LeftPanel if it is closed, or vice versa }); &lt;static&gt; toggleFullScreen() Toggles full scree mode of the browser. Example WebViewer(...) .then(function(instance) { instance.UI.toggleFullScreen(); }); &lt;static&gt; toggleReaderMode() Toggles Reader mode of the viewer. Note that Reader mode only works with fullAPI enabled. Example WebViewer(...) .then(function(instance) { instance.UI.toggleReaderMode(); }); &lt;static&gt; unregisterTool(toolName) Unregisters tool in the document viewer tool mode map, and removes the button object. Parameters: Name Type Description toolName string Name of the tool, either from tool names list or the name you registered your custom tool with. Example WebViewer(...) .then(function(instance) { instance.UI.unregisterTool('MyTool'); }); &lt;static&gt; unselectThumbnailPages(pageNumbers) Unselect selected thumbnails Parameters: Name Type Description pageNumbers Array.&lt;number&gt; array of page numbers to unselect Example // 6.1 and after WebViewer(...) .then(function(instance) { const pageNumbersToUnselect = [1, 2]; instance.UI.unselectThumbnailPages(pageNumbersToUnselect); }); &lt;static&gt; updateElement(dataElement, props) Update an element in the viewer. Parameters: Name Type Description dataElement string the data element of the element that will be updated. Only the data element of HTML elements that have 'Button' in the class name will work. props object An object that is used to override an existing item's properties. Example WebViewer(...) .then(function(instance) { instance.UI.updateElement('thumbnailsPanelButton', { img: 'path/to/image', title: 'new_tooltip', }) }); &lt;static&gt; updateTool(toolName [, properties]) Update existing tool's properties. Parameters: Name Type Argument Description toolName string Name of the tool, either from tool names list or the name you registered your custom tool with. properties object &lt;optional&gt; Tool properties Properties Name Type Argument Description buttonImage string &lt;optional&gt; Path to an image or base64 data for the tool button buttonName string &lt;optional&gt; Name of the tool button that will be used in data-element buttonGroup string &lt;optional&gt; Group of the tool button belongs to tooltip string &lt;optional&gt; Tooltip of the tool button Example WebViewer(...) .then(function(instance) { instance.UI.updateTool('AnnotationCreateSticky', { buttonImage: 'https://www.pdftron.com/favicon-32x32.png' }); }); &lt;static&gt; useEmbeddedPrint( [use]) Use/not use embedded printing. Only applicable to Chrome. The printing process will be faster and the quality might be higher when using Chrome's native printing. You may not want to use embedded printing if there are custom annotations in your document. Parameters: Name Type Argument Default Description use boolean &lt;optional&gt; true Whether or not to use embedded printing Example WebViewer(...) .then(function(instance) { instance.UI.useEmbeddedPrint(false); // disable embedded printing }); &lt;static&gt; willUseEmbeddedPrinting() Returns whether Webviewer will use/not use embedded printing. Will return false if the browser doesn't support embedded printing or if UI.useEmbeddedPrint is set to false. Example WebViewer(...) .then(function(instance) { instance.UI.willUseEmbeddedPrinting(); // Returns true/false if embedded printing is supported and enabled }); Type Definitions addTabOptions Type: Object Properties: Name Type Argument Description loadDocumentOptions UI.loadDocumentOptions &lt;optional&gt; The document loading options setActive boolean &lt;optional&gt; Whether to set the new tab as active immediately after adding it (default: true) saveCurrentActiveTabState boolean &lt;optional&gt; Whether to save the current tab annotations, scroll position, and zoom level before adding the new tab (only used when setActive=true) (default: true) CustomApplyRedactionsHandler(annotations, originalApplyRedactionsFunction) Parameters: Name Type Description annotations Array.&lt;Core.Annotations.Annotation&gt; originalApplyRedactionsFunction function The original applyRedactions function CustomNoteSelectionFunction(annotation) Parameters: Name Type Description annotation Core.Annotations.Annotation A reference to the annotation object associated with the note disableReplyForAnnotationsCallback(annotation) Callback that gets passed to disableReplyForAnnotations. Parameters: Name Type Description annotation Core.Annotations.Annotation Annotation object Returns: True if replies for the annotation passed in should be disabled. False otherwise. Type boolean filterAnnotation(annotation) Callback that gets passed to setCustomNoteFilter. Parameters: Name Type Description annotation Core.Annotations.Annotation Annotation object Returns: Whether the annotation should be kept. Type boolean getSeparatorContent(prevNote, currNote, options) Callback that gets passed to `sortStrategy.getSeparatorContent` in addSortStrategy. Parameters: Name Type Description prevNote Core.Annotations.Annotation Previous note (annotation) currNote Core.Annotations.Annotation Current note (annotation) options object Optional values Properties Name Type Description pageLabels Array.&lt;string&gt; List of page label Returns: Content to be rendered in a separator Type string | number getSortedNotes(notes) Callback that gets passed to `sortStrategy.getSortedNotes` in addSortStrategy. Parameters: Name Type Description notes Array.&lt;Core.Annotations.Annotation&gt; List of unsorted notes (annotations) Returns: Sorted notes (annotations) Type Array.&lt;Core.Annotations.Annotation&gt; headerCallback(header) Callback that gets passed to setHeaderItems. Parameters: Name Type Description header UI.Header Header instance with helper functions loadDocumentOptions Type: Object Properties: Name Type Argument Description extension string &lt;optional&gt; The extension of the file. If file is a blob/file object or a URL without an extension then this is necessary so that WebViewer knows what type of file to load. filename string &lt;optional&gt; Filename of the document, which is used when downloading the PDF. customHeaders object &lt;optional&gt; An object of custom HTTP headers to use when retrieving the document from the specified url. webViewerServerCustomQuerypropertyeters object &lt;optional&gt; An object of custom query propertyeters to be appended to every WebViewer Server request. documentId string &lt;optional&gt; Unique id of the document. withCredentials boolean &lt;optional&gt; Whether or not cross-site requests should be made using credentials. cacheKey string &lt;optional&gt; A key that will be used for caching the document on WebViewer Server. officeOptions object &lt;optional&gt; An object that contains the options for an Office document. Properties Name Type Argument Description templateValues Core.TemplateData &lt;optional&gt; If set, will perform template replacement with the data specified by this parameter doTemplatePrep boolean &lt;optional&gt; If set, it will interpret the office document as a template document and compile all of the template tags in the document disableBrowserFontSubstitution boolean &lt;optional&gt; By default, office viewing takes a lightweight approach to font substitution, allowing the browser to select fonts when they are not embedded in the document itself. While this means that WebViewer has access to all the fonts on the user's system, it also means that an office document may have a different \"look\" on different systems (depending on the fonts available) and when it is converted to PDF (as the PDF conversion routine cannot obtain low-level access to user fonts, for security reasons). disableBrowserFontSubstitution prevents this browser substitution, forcing the WebViewer backend to handle all fonts. This means that viewing and conversion to PDF will be 100% consistent from system-to-system, at the expense of a slightly slower initial viewing time and higher bandwidth usage. Using https://www.pdftron.com/documentation/web/faq/self-serve-substitute-fonts/ along with this option allows you to fully customize the substitution behaviour for all office files. formatOptions object &lt;optional&gt; An object that contains formatting options for an Office document. Same options as allowed here Core.PDFNet.Convert.OfficeToPDFOptions. Properties Name Type Argument Description applyPageBreaksToSheet boolean &lt;optional&gt; If true will split Excel worksheets into pages so that the output resembles print output. displayChangeTracking boolean &lt;optional&gt; If true will display office change tracking markup present in the document (i.e, red strikethrough of deleted content and underlining of new content). Otherwise displays the resolved document content, with no markup. Defaults to true. excelDefaultCellBorderWidth number &lt;optional&gt; Cell border width for table cells that would normally be drawn with no border. In units of points. Can be used to achieve a similar effect to the \"show gridlines\" display option within Microsoft Excel. excelMaxAllowedCellCount number &lt;optional&gt; An exception will be thrown if the number of cells in an Excel document is above the value. Used for early termination of resource intensive documents. Setting this value to 250000 will allow the vast majority of Excel documents to convert without issue, while keeping RAM usage to a reasonable level. By default there is no limit to the number of allowed cells. locale string &lt;optional&gt; Sets the value for Locale in the options object ISO 639-1 code of the current system locale. For example: 'en-US', 'ar-SA', 'de-DE', etc. password string &lt;optional&gt; A string that will be used to as the password to load a password protected document. onError function &lt;optional&gt; A callback function that will be called when error occurs in the process of loading a document. The function signature is `function(e) {}` xodOptions object &lt;optional&gt; An object that contains the options for a XOD document. xoddecrypt boolean &lt;optional&gt; Function to be called to decrypt a part of the XOD file. For default XOD AES encryption pass Core.Encryption.decrypt. xoddecryptOptions boolean &lt;optional&gt; An object with options for the decryption e.g. {p: \"pass\", type: \"aes\"} where is p is the password. xodstreaming boolean &lt;optional&gt; A boolean indicating whether to use http or streaming PartRetriever, it is recommended to keep streaming false for better performance. https://www.pdftron.com/documentation/web/guides/streaming-option. xodazureWorkaround boolean &lt;optional&gt; Whether or not to workaround the issue of Azure not accepting range requests of a certain type. Enabling the workaround will add an extra HTTP request of overhead but will still allow documents to be loaded from other locations. xodstartOffline boolean &lt;optional&gt; Whether to start loading the document in offline mode or not. This can be set to true if the document had previously been saved to an offline database using WebViewer APIs. You'll need to use this option to load from a completely offline state. NoteTransformFunction(wrapperElement, state, createElement) Parameters: Name Type Description wrapperElement HTMLElement A reference to the DOM node that wraps the note. You can use this to query select child elements to mutate (see the examples below) state object The state of the note. Contains two properties, 'annotation' and 'isSelected' Properties Name Type Description annotation Core.Annotations.Annotation A reference to the annotation object associated with the note isSelected boolean whether or not the note is currently expanded createElement function A utility function that should be used when creating DOM nodes. This is a replacement for `document.createElement`. Accepts the same parameters as `document.createElement`. Using document.createElement instead of this function will cause your DOM nodes to not be cleaned up on subsequent renders. PaletteOption Properties: Name Type Description toolNames Array.&lt;string&gt; Tools that will have the same colors in the palette. colors Array.&lt;string&gt; An array of hex colors. Use 'transparency' for a transparent color. RedactionSearchPattern Type: Object Properties: Name Type Argument Description label string The label to be used for the search pattern in the UI type string A string representing the type of item being searched for. For example, if searching for postal codes, this could be 'postalCode'. This is used to determine which icon will be used to render the result in the search panel. icon string &lt;optional&gt; The icon to be used for the search pattern in the search dropdown for the UI and the redaction panel for this type of search. Can be an inline SVG, or the name of an icon included in the WebViewer UI icon set. If no icon is passed, the default icon for text searches will be used. regex RegExp The regex to be used for the search pattern renderCustomModal() Callback that gets passed to `options.render` in addCustomModal. Returns: Modal element. If string is returned, it will be displayed as is inside the modal Type HTMLElement | string renderCustomPanel() Callback that gets passed to `options.panel.render` in setCustomPanel. Returns: Panel element. Type HTMLElement searchListener(searchValue, options, results) Callback that gets passed to addSearchListener. Parameters: Name Type Description searchValue string Search value options object Search options object, which includes 'caseSensitive', 'wholeWord', 'wildcard' and 'regex' results Array.&lt;object&gt; Search results setSignatureFontsCallback(fonts) Parameters: Name Type Description fonts Array.&lt;string&gt; current font families Returns: fonts to set. Type Array.&lt;string&gt; shouldRenderSeparator(prevNote, currNote) Callback that gets passed to `sortStrategy.shouldRenderSeparator` in addSortStrategy. Parameters: Name Type Description prevNote Core.Annotations.Annotation Previous note (annotation) currNote Core.Annotations.Annotation Current note (annotation) Returns: Whether a separator should be rendered or not Type boolean SignatureFilterFunction(annotation, index) Parameters: Name Type Description annotation Core.Annotations.Annotation A signature annotation found in the SignatureCreateTool saved signatures list index number An optional parameter for the index of the annotaiton parameter within the SignatureCreateTool saved signatures list Returns: Whether or not a signature annotation should be included in the annotation preset Type boolean Theme Contains string enumeration for all themes for WebViewer. They are used to set the viewer theme. Properties: Name Type Description DARK string The theme where the WebViewer will be dark. LIGHT string The theme where the WebViewer will be light. Example WebViewer(...) .then(function(instance) { const theme = instance.UI.Theme; instance.UI.setTheme(theme.DARK); }); Events annotationFilterChanged Triggered when annotation filter in the notes panel has changed. Returns empty arrays if the filter is cleared. Type: object Properties: Name Type Description types Array.&lt;string&gt; Types filter authors Array.&lt;string&gt; Author filter colors Array.&lt;string&gt; Color filter statuses Array.&lt;string&gt; Status filter beforeTabChanged Triggered before the UI switches tabs Type: object Properties: Name Type Description currentTab object An object containing the properties for the currently active tab (null if no currently active tab) Properties Name Type Description id number The id of the tab being switched to src string Source of current tab options string Tab load options annotationsChanged boolean True if the annotations have been changed since loading the tab nextTab object An object containing the properties for the tab being switched to Properties Name Type Description id number The id of the tab being switched to src string Source of current tab options string Tab load options documentLoaded Triggered when a new document has been loaded. documentMerged Triggered when a new document has been merged into the thumbnails panel. Type: object Properties: Name Type Description filename string File name pages Array.&lt;number&gt; Page numbers dragOutline Triggered when dragging Outline item. dragOutline Triggered when dropping Outline item. fileDownloaded Triggered when the file has finished downloading. finishedSavingPDF Deprecated: Since version 8.3. Use fileDownloaded instead fullscreenModeToggled Triggered when fullscreen mode is toggled. Type: object Properties: Name Type Description isInFullscreen boolean Whether in fullscreen mode or not. loaderror Triggered when there is an error loading the document. Parameters: Name Type Description err object The error outlineBookmarksChanged Triggered when outline bookmarks have changed. Parameters: Name Type Description bookmarkData object Properties Name Type Description bookmark object The changed bookmark Properties Name Type Description id string Changed outline bookmark id name string Changed outline bookmark name path string Changed outline path in the outline tree action string The action that triggered the outline bookmarks change panelResized Triggered when the panels are resized. Type: object Properties: Name Type Description element string DataElement name width number New panel width selectedThumbnailChanged Triggered when the selected thumbnail changed. Parameters: Name Type Description selectedThumbnailPageIndexes array The array of indexes of currently selected thumbnails tabAdded Triggered when a Tab is added Type: object Properties: Name Type Description id number The id of the tab being added src string Source of current tab options string Tab load options tabDeleted Triggered when a Tab is deleted Type: object Properties: Name Type Description id number The id of the tab being deleted src string Source of current tab options string Tab load options tabMoved Triggered when a Tab is moved Type: object Properties: Name Type Description id number The id of the tab being moved src string Source of moved tab options string Tab load options prevIndex number Previous index of tab newIndex number New index of tab themeChanged Triggered when the UI theme has changed. Parameters: Name Type Description theme string The new UI theme thumbnailDragged Triggered when thumbnail(s) are dragged in the thumbnail panel thumbnailDropped Triggered when dragged thumbnail(s) are dropped to a new location in the thumbnail panel Type: object Properties: Name Type Description pageNumbersBeforeMove Array.&lt;number&gt; The array of page numbers to be moved pageNumbersAfterMove Array.&lt;number&gt; The array of page numbers of where thumbnails being dropped numberOfPagesMoved number Number of page(s) being moved toolbarGroupChanged Triggered when the toolbar group has changed. Parameters: Name Type Description toolbarGroup string The new toolbar group userBookmarksChanged Triggered when user bookmarks have changed. Parameters: Name Type Description bookmarks object The new bookmarks viewerLoaded Triggered when the viewer has loaded. visibilityChanged Triggered when the visibility of an element has changed. Type: object Properties: Name Type Description element string DataElement name isVisible boolean The new visibility × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:50-07:00 using the DocStrap template. "},"UI.Fonts.html":{"id":"UI.Fonts.html","title":"Namespace: Fonts","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: Fonts UI. Fonts A namespace which contains Font APIs for the UI. Example WebViewer(...) .then(function (instance) { instance.UI.Fonts.getFonts(); }); Methods &lt;static&gt; addAnnotationFont(font) Add a font to be available in the UI for Annotation font pickers. Parameters: Name Type Description font String The font to be added. Example WebViewer(...) .then(function(instance) { instance.UI.Fonts.addAnnotationFont(\"Arial\"); }); &lt;static&gt; addSignatureFont(font) Add a font to be available in the UI for Signature font pickers. Parameters: Name Type Description font String The font to be added. Example WebViewer(...) .then(function(instance) { instance.UI.Fonts.addSignatureFont(\"Arial\"); }); &lt;static&gt; getAnnotationFonts() Return the currently available fonts in the UI to be used for Annotations. Returns: Fonts avaialable in the UI. Type Array.&lt;String&gt; Example WebViewer(...) .then(function(instance) { instance.UI.Fonts.getAnnotationFonts(); }); &lt;static&gt; getSignatureFonts() Returns the currently available fonts to be used when typing a signature in the signature dialog Returns: Fonts avaialable in the UI. Type Array.&lt;String&gt; &lt;static&gt; removeAnnotationFont(font) Remove a font from the UI's Annotation font pickers. Parameters: Name Type Description font String The font to be removed. Example WebViewer(...) .then(function(instance) { instance.UI.Fonts.removeAnnotationFont(\"Arial\"); }); &lt;static&gt; removeSignatureFont(font) Remove a font from the UI's Signature font pickers. Parameters: Name Type Description font String The font to be removed. Example WebViewer(...) .then(function(instance) { instance.UI.Fonts.removeSignatureFont(\"Arial\"); }); &lt;static&gt; setAnnotationFonts(fonts) Set the fonts available in the UI's Annotation font pickers. Parameters: Name Type Description fonts Array.&lt;String&gt; The fonts to be set. Example WebViewer(...) .then(function(instance) { instance.UI.Fonts.setAnnotationFonts([\"Arial\", \"Times New Roman\"]); }); &lt;static&gt; setSignatureFonts(fonts) Set the fonts available in the UI's Signature font pickers. Parameters: Name Type Description fonts Array.&lt;String&gt; The fonts to be set. Example WebViewer(...) .then(function(instance) { instance.UI.Fonts.setSignatureFonts([\"Arial\", \"Times New Roman\"]); }); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:50-07:00 using the DocStrap template. "},"UI.Header.html":{"id":"UI.Header.html","title":"Class: Header","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: Header UI. Header new Header() A class which contains header APIs. ⚠ You must NOT instantiate this yourself. Access the header instance in setHeaderItems as follows: Example WebViewer(...) .then(function(instance) { instance.UI.setHeaderItems(function(header) { // instance of Header is passed to the callback }); }); Methods delete( [id]) Delete a button. Parameters: Name Type Argument Description id number | string &lt;optional&gt; You can either pass an index or `data-element` of the button to delete. If you already selected a button from get, passing null would delete the selected button. Returns: Header object for chaining. You can call get, getItems, shift, unshift, push, pop and update. Type UI.Header get(dataElement) Select a button from header to edit. Parameters: Name Type Description dataElement string data-element of the button. Returns: Header object for chaining. You can call insertBefore, insertAfter and delete to perform an operation on the button. Type UI.Header getHeader(headerGroup) Select a header group to edit. Parameters: Name Type Description headerGroup string Name of the header group. Possible options are 'default', 'small-mobile-more-buttons', 'toolbarGroup-View', 'toolbarGroup-Annotate', 'toolbarGroup-Shapes', 'toolbarGroup-Insert', 'toolbarGroup-Measure', and 'toolbarGroup-Edit' Returns: Header object for chaining. You can call get, getItems, shift, unshift, push, pop and update. Type UI.Header getItems() Get all list of header items from a group selected from getHeader. By default, it returns the items from 'default' group. Returns: List of header item objects. You can edit it using normal array operations and update the whole header by passing it to update. Type Array.&lt;object&gt; insertAfter(obj) Insert a button after the selected button from get. Parameters: Name Type Description obj object A header object. See Header items for details. Returns: Header object for chaining. You can call get, getItems, shift, unshift, push, pop and update. Type UI.Header insertBefore(obj) Insert a button before the selected button from get. Parameters: Name Type Description obj object A header object. See Header items for details. Returns: Header object for chaining. You can call get, getItems, shift, unshift, push, pop and update. Type UI.Header pop() Removes the last button in the header. Returns: Header object for chaining. You can call get, getItems, shift, unshift, push, pop and update. Type UI.Header push(obj) Adds a button (or buttons) to the end of the header. Parameters: Name Type Description obj object | Array.&lt;object&gt; Either one or array of header objects. See Header items for details. Returns: Header object for chaining. You can call get, getItems, shift, unshift, push, pop and update. Type UI.Header shift() Removes the first button in the header. Returns: Header object for chaining. You can call get, getItems, shift, unshift, push, pop and update. Type UI.Header unshift(obj) Adds a button (or buttons) to the beginning of the header. Parameters: Name Type Description obj object | Array.&lt;object&gt; Either one or array of header objects. See Header items for details. Returns: Header object for chaining. You can call get, getItems, shift, unshift, push, pop and update. Type UI.Header update(headerObjects) Updates the header with new list of header items. Parameters: Name Type Description headerObjects Array.&lt;object&gt; List of header objects to replace the exising header. You can use getItems to refer to existing header objects. Returns: Header object for chaining. You can call get, getItems, shift, unshift, push, pop and update. Type UI.Header × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:50-07:00 using the DocStrap template. "},"UI.Hotkeys.html":{"id":"UI.Hotkeys.html","title":"Namespace: Hotkeys","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: Hotkeys UI. Hotkeys A class which contains hotkeys APIs. ⚠ You must NOT instantiate this yourself. Access instances of this class using instance.UI.hotkeys Members &lt;static&gt; Keys Available hotkeys that can be passed to instance.UI.hotkeys.on or instance.UI.hotkeys.off. Type: string Properties: Name Type Description CTRL_SHIFT_EQUAL string Rotate the document clockwise COMMAND_SHIFT_EQUAL string Rotate the document clockwise CTRL_SHIFT_MINUS string Rotate the document counterclockwise COMMAND_SHIFT_MINUS string Rotate the document counterclockwise CTRL_C string Copy selected text or annotations COMMAND_C string Copy selected text or annotations CTRL_V string Paste text or annotations COMMAND_V string Paste text or annotations CTRL_Z string Undo an annotation change COMMAND_Z string Undo an annotation change CTRL_Y string Redo an annotation change COMMAND_SHIFT_Z string Redo an annotation change CTRL_O string Open the file picker COMMAND_O string Open the file picker CTRL_F string Open the search overlay COMMAND_F string Open the search overlay CTRL_EQUAL string Zoom in COMMAND_EQUAL string Zoom in CTRL_MINUS string Zoom out COMMAND_MINUS string Zoom out CTRL_0 string Fit the document to the screen width in a small screen(&lt; 640px), otherwise fit it to its original size COMMAND_0 string Fit the document to the screen width in a small screen(&lt; 640px), otherwise fit it to its original size CTRL_P string Print COMMAND_P string Print PAGE_UP string Go to the previous page PAGE_DOWN string Go to the next page UP string Go to the previous page in single layout mode (ArrowUp) DOWN string Go to the next page in single layout mode (ArrowDown) SPACE string Hold to switch to Pan mode and release to return to previous tool ESCAPE string Select the AnnotationEdit tool P string Select the Pan tool A string Select the AnnotationCreateArrow tool C string Select the AnnotationCreateCallout tool E string Select the AnnotationEraserTool tool F string Select the AnnotationCreateFreeHand tool I string Select the AnnotationCreateStamp tool L string Select the AnnotationCreateLine tool N string Select the AnnotationCreateSticky tool O string Select the AnnotationCreateEllipse tool R string Select the AnnotationCreateRectangle tool T string Select the AnnotationCreateFreeText tool S string Open the signature modal or the overlay G string Select the AnnotationCreateTextSquiggly tool H string Select the AnnotationCreateTextHighlight tool K string Select the AnnotationCreateTextStrikeout tool U string Select the AnnotationCreateTextUnderline tool Methods &lt;static&gt; off( [key] [, handler]) Remove an event handler for the given hotkey Parameters: Name Type Argument Description key string | UI.Hotkeys.Keys &lt;optional&gt; An optional keyboard key. If not passed, all handlers will be removed handler function &lt;optional&gt; An optional function. If not passed, all handlers of the given key will be removed Example WebViewer(...) .then(function(instance) { // this will remove all handlers for ctrl = and command = instance.UI.hotkeys.off(instance.UI.hotkeys.Keys.CTRL_EQUAL); instance.UI.hotkeys.off(instance.UI.hotkeys.Keys.COMMAND_EQUAL); }); &lt;static&gt; on(key [, handler]) Add an event handler for the given hotkey Parameters: Name Type Argument Description key string | UI.Hotkeys.Keys A keyboard key If a hotkey is consisted of more than one key. Those keys should be connected using '+'. handler function | object &lt;optional&gt; An optional argument If it is undefined, the default handler of the given key will be registered If it is an function, it will be called on key down If it is an object, it should have the shape of { keydown: func1, keyup: func2 }. Func1 will be called on keydown while func2 will be called on keyup Example WebViewer(...) .then(function(instance) { const { UI } = instance; // this will register the default zoom in handler UI.hotkeys.on(UI.hotkeys.Keys.CTRL_EQUAL); UI.hotkeys.on(UI.hotkeys.Keys.COMMAND_EQUAL); // this will be called on keydown UI.hotkeys.on('ctrl+d, command+d', e =&gt; { e.preventDefault(); instance.Core.documentViewer.closeDocument(); }); UI.hotkeys.on('ctrl+g', { keydown: e =&gt; { console.log('ctrl+g is pressed!'); }, keyup: e =&gt; { console.log('ctrl+g is released!') }, }); }); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:50-07:00 using the DocStrap template. "},"UI.MentionsManager.html":{"id":"UI.MentionsManager.html","title":"Class: MentionsManager","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: MentionsManager UI. MentionsManager new MentionsManager() Extends Core.EventHandler Methods addEventListener(type, fn [, options]) Add a handler to the given event name Parameters: Name Type Argument Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered options object &lt;optional&gt; Optional options object for addEventListener Properties Name Type Description once boolean If true then the handler will be called only once Inherited From: Core.EventHandler#addEventListener Returns: Returns the object that 'addEventListener' is being called on Type object Example myObject.addEventListener('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); defaultMentionLookupCallback() The default mention lookup callback used to filter users in the suggestions overlay. getAllowedTrailingCharacters() Gets the allowed trailing characters Returns: An array of trailing characters, or '*' Type Array.&lt;string&gt; | '*' getMentionLookupCallback() Gets the current mention lookup callback function being used by quill-mentions to filter the users in the suggestions overlay. Returns: the current function used to filter users in the suggestions overlay Type function getUserData() Gets the user data Returns: An array of user data Type Array.&lt;UI.MentionsManager.UserData&gt; off( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#off Deprecated: Since version 8.0. Use removeEventListener instead. Returns: Returns the object that 'off' is being called on Type object Example myObject.off(); myObject.off('eventName'); myObject.off('eventName', fn); on(type, fn) Add a handler to the given event name Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#on Deprecated: Since version 8.0. Use addEventListener instead. Returns: Returns the object that 'on' is being called on Type object Example myObject.on('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); one(type, fn) Same as 'on' except the handler will be called only once Parameters: Name Type Description type string | number The name of the event to listen to fn function The handler to be called when the event is triggered Inherited From: Core.EventHandler#one Deprecated: Since version 8.0. Use addEventListener with {'once': true} as options instead. Returns: Returns the object that 'one' is being called on Type object Example myObject.one('eventName', (eventParameter1, eventParameter2) =&gt; { ... }); removeEventListener( [type] [, fn]) Remove a handler of the given event name Parameters: Name Type Argument Description type string | number &lt;optional&gt; The name of the event to remove the handler of. If type is undefined, all the handlers of the object will be removed fn function &lt;optional&gt; The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event name will be removed Inherited From: Core.EventHandler#removeEventListener Deprecated: for version 9.0. Use [removeEventListener] with fn specified Returns: Returns the object that 'removeEventListener' is being called on Type object Example myObject.removeEventListener(); myObject.removeEventListener('eventName'); myObject.removeEventListener('eventName', fn); setAllowedTrailingCharacters(chars) Sets the characters that can follow a mention, while not invalidating it By default, a mention can only be followed by a space, or is located at the end of the string Parameters: Name Type Description chars Array.&lt;string&gt; | '*' An array of characters. If `*` is passed, then a mention can be followed by any characters Example WebViewer(...) .then(function(instance) { instance.mentions.setUserData([ { value: 'John Doe', }, ]); // this is considered as a mention, because `@John Doe` is at the end of the string 'Hello, @John Doe' // this is considered as a mention, because `@John Doe` is followed by a space 'Hello, @John Doe How are you?' // this is NOT considered as a mention, because `@John Doe` is followed by a comma '@John Doe, Hello!' instance.mentions.setAllowedTrailingCharacters([' ', ',']); // this is now considered as a mention, because comma is an allowed trailing character '@John Doe, Hello!' }); setMentionLookupCallback(callback) Sets the mention lookup callback function used by quill-mentions to filter the users in the suggestions overlay. Parameters: Name Type Description callback function A callback function that returns an array of users that displayed in the suggestions overlay. Example WebViewer(...) .then(function(instance) { instance.mentions.setMentionLookupCallback(async (userData, searchTerm) =&gt; { const matches = []; userData.forEach((user) =&gt; { if (user.name === 'John Doe') { matches.push(user); } }); return matches; }); }); setUserData(userData) Sets the user data that will be displayed in the suggestions overlay when an @ is entered in the textarea. Parameters: Name Type Description userData Array.&lt;UI.MentionsManager.UserData&gt; An array of user data Example WebViewer(...) .then(function(instance) { instance.mentions.setUserData([ { value: 'John Doe', }, { value: 'Jane Doe', email: 'jDoe@gmail.com' } ]); }); trigger(type [, data]) Calls the handlers of the event name with given data Parameters: Name Type Argument Description type string | number event name of which the handlers will be called. data * &lt;optional&gt; data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers Inherited From: Core.EventHandler#trigger Returns: Returns the object that 'trigger' is being called on Type object Example myObject.trigger('eventName'); myObject.trigger('eventName', [eventParameter1, eventParameter2]); Type Definitions Mention Type: Object Properties: Name Type Description email string The email of the mentioned person. This is passed from setUserData. value string The value(display name) of the mentioned person. This is passed from setUserData. type string The type of the mentioned person. This is passed from setUserData. id string The id of the mentioned person. This is passed from setUserData. annotId string The id of the annotation in which the contents contain the mentions. UserData Type: Object.&lt;string, string&gt; Properties: Name Type Argument Description value string The display name of the user, which will be displayed in the suggestion overlay. id string &lt;optional&gt; The unique id of the user. Default to `value`. email string &lt;optional&gt; The email of the user, which will be displayed under `value` in the suggestion overlay, if present. Events mentionChanged Triggered when a mention or mentions have been changed (added, deleted, modified). Attach like instance.mentions.on('mentionChanged', callback) Parameters: Name Type Description mentions UI.MentionsManager.Mention The mentions that were changed action 'add' | 'modify' | 'delete' The action that occurred (add, delete, modify) × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:50-07:00 using the DocStrap template. "},"UI.MenuOverlay.html":{"id":"UI.MenuOverlay.html","title":"Interface: MenuOverlay","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Interface: MenuOverlay UI. MenuOverlay A class which contains MenuOverlay APIs. ⚠ If you want to remove an item in a MenuOverlay, use disableElements. Methods add(items [, dataElement]) Add an array of Actions Buttons after the item that has the given data element. Parameters: Name Type Argument Description items Array.&lt;object&gt; Same as ActionButton dataElement string &lt;optional&gt; An optional string. If not given, items will be added in the beginning Returns: The instance itself Type this Example WebViewer(...) .then(function(instance) { instance.UI.settingsMenuOverlay.add({ type: 'actionButton', className:\"row\", img: 'icon-header-print-line', onClick: () =&gt; { alert('Printing...'); }, dataElement: 'alertButton', label:'print button' }); }); getItems() Return the array of items in the menuOverlay dropdown. Returns: Current items in the menuOverlay dropdown. Type Array.&lt;object&gt; Example WebViewer(...) .then(function(instance) { instance.UI.settingsMenuOverlay.getItems(); }); update( [items]) Update all the items in the menuOverlay dropdown. To update an individual item, use updateElement Parameters: Name Type Argument Description items Array.&lt;object&gt; &lt;optional&gt; the items that will be rendered in the menuOverlay dropdown Returns: The instance itself Type this Example WebViewer(...) .then(function(instance) { // replace existing items with a new array of items instance.UI.settingsMenuOverlay.update([ { type: 'actionButton', className:\"row\", img: 'icon-header-print-line', onClick: () =&gt; { alert('Hello world!'); }, dataElement: 'alertButton', label:'test button', role:\"option\" }, { type: 'actionButton', className:\"row\", img: 'icon-header-print-line', onClick: () =&gt; { alert('Hello world!'); }, dataElement: 'alertButton2', label:'test button 2', role:\"option\" }, ]); }); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:50-07:00 using the DocStrap template. "},"UI.NotesPanel.html":{"id":"UI.NotesPanel.html","title":"Namespace: NotesPanel","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: NotesPanel UI. NotesPanel Methods &lt;static&gt; disableAutoExpandCommentThread() Disables the automatic expansion of all the comments threads in the Notes Panel. Example WebViewer(...).then(async function(instance) { instance.UI.NotesPanel.disableAutoExpandCommentThread() }); &lt;static&gt; disableReplyCollapse() Disables the collapsing of the replies in the Notes Panel. Example WebViewer(...).then(async function(instance) { instance.UI.NotesPanel.disableReplyCollapse() }); &lt;static&gt; disableTextCollapse() Disables the collapsing of the annotation's text in the Notes Panel. Example WebViewer(...).then(async function(instance) { instance.UI.NotesPanel.disableTextCollapse() }); &lt;static&gt; enableAutoExpandCommentThread() Enables the automatic expansion of the comments threads in the Notes Panel. Example WebViewer(...).then(async function(instance) { instance.UI.NotesPanel.enableAutoExpandCommentThread() }); &lt;static&gt; enableReplyCollapse() Enables the collapsing of the replies in the Notes Panel. Example WebViewer(...).then(async function(instance) { instance.UI.NotesPanel.enableReplyCollapse() }); &lt;static&gt; enableTextCollapse() Enables the collapsing of the annotation's text in the Notes Panel. Example WebViewer(...).then(async function(instance) { instance.UI.NotesPanel.enableTextCollapse() }); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:50-07:00 using the DocStrap template. "},"UI.PageManipulationOverlay.html":{"id":"UI.PageManipulationOverlay.html","title":"Interface: PageManipulationOverlay","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Interface: PageManipulationOverlay UI. PageManipulationOverlay A class which contains PageManipulationOverlay APIs. ⚠ If you want to remove an item in the PageManipulationOverlay, use disableElements. Methods add(PageManipulationSection [, dataElementToInsertAfter]) Adds an array of page manipulation operations to the default operations. If passed a dataElement parameter, it will add the new operations after this element. Otherwise, they will be appended to the start of the existing list of operations. Parameters: Name Type Argument Description PageManipulationSection Array.&lt;UI.PageManipulationOverlay.PageManipulationSection&gt; Array of sections to be added, each with its individual operations. See example below. dataElementToInsertAfter 'pageRotationControls' | 'pageInsertionControls' | 'pageManipulationControls' &lt;optional&gt; An optional string that determines where in the overlay the new section will be added. If not included, the new page manipulation section will be added at the top. You can call getItems to get existing items and their dataElements. Returns: The instance itself Type UI.PageManipulationOverlay Example // Each object in the operations array shall consist of the following: { type: 'customPageOperation', // Required type of 'customPageOperation' header: 'Custom options', // Header to be displayed in the UI dataElement: 'customPageOperations', // Unique dataElement // Each new section can have one more more operations. // The onClick handler for each operation gets passed an array of the currently selected // thumbnail page numbers. operations: [ { title: 'Alert me of selected thumbnail page numbers', img: '/path-to-image', onClick: (selectedPageNumbers) =&gt; { alert(`Selected thumbnail pages: ${selectedPageNumbers}`); }, dataElement: 'customPageOperationButton', // Each operation must have a dataElement } ] } // Additionally, to add dividers you can include this in the operations array: { type: 'divider' } // Example: WebViewer(...) .then(function (instance) { instance.UI.pageManipulationOverlay.add([ { type: 'customPageOperation', header: 'Custom options', dataElement: 'customPageOperations', operations: [ { title: 'Alert me', img: '/path-to-image', onClick: (selectedPageNumbers) =&gt; { alert(`Selected thumbnail pages: ${selectedPageNumbers}`); }, dataElement: 'customPageOperationButton', } ] }, { type: 'divider' } ]); }); getItems() Return the array of items in the PageManipulationOverlay. Returns: Current items in the PageManipulationOverlay. Type Array.&lt;UI.PageManipulationOverlay.PageManipulationSection&gt; Example WebViewer(...) .then(function(instance) { instance.UI.pageManipulationOverlay.getItems(); }); update(PageManipulationSection) Update all the operations in the PageManipulationOverlay, essentially replacing them with a new list of operations. To update an individual item, use updateElement Parameters: Name Type Description PageManipulationSection Array.&lt;UI.PageManipulationOverlay.PageManipulationSection&gt; The list of PageManipulationSections that will be rendered in the PageManipulation overlay. See the add documentation for an example. Returns: The instance of itself Type UI.PageManipulationOverlay Example WebViewer(...) .then(function (instance) { instance.UI.pageManipulationOverlay.update([ { type: 'customPageOperation', header: 'Print Operations', dataElement: 'customPageOperations', operations: [ { title: 'Print page', img: 'icon-header-print-line', onClick: (selectedPageNumbers) =&gt; { alert(`Selected thumbnail pages: ${selectedPageNumbers}`); }, dataElement: 'printThumbnailPage', } ] }, { type: 'divider' }, { type: 'customPageOperation', header: 'Alert Operations', dataElement: 'customPageOperations-2', operations: [ { title: 'Alert me', img: 'icon-header-print-line', onClick: (selectedPageNumbers) =&gt; { alert(`Selected thumbnail pages: ${selectedPageNumbers}`); }, dataElement: 'alertPage', } ] } ]); }); Type Definitions PageManipulationSection Type: object Properties: Name Type Description type string Required type of 'customPageOperation' header string Header to be displayed in the UI for this section dataElement string Unique dataElement operations Array.&lt;UI.PageManipulationOverlay.PageOperation&gt; the operations that will be available under this section PageOperation Type: object Properties: Name Type Description title string Title to be displayed for the operation img string path to imge to be used as an icon for the operation onClick function onClick handler, which takes as a parameter an array of selected page numbers dataElement string Unique dataElement for this operation × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:50-07:00 using the DocStrap template. "},"UI.Popup.html":{"id":"UI.Popup.html","title":"Interface: Popup","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Interface: Popup UI. Popup A class which contains popup APIs. ⚠ If you want to remove an item in a popup, use disableElements. Methods add(items [, dataElement]) Add an array of items after the item that has the given data element. Parameters: Name Type Argument Description items Array.&lt;object&gt; Same as header items dataElement string &lt;optional&gt; An optional string. If not given, items will be added in the beginning Returns: The instance itself Type this Example WebViewer(...) .then(function(instance) { instance.contextMenuPopup.add({ type: 'actionButton', img: 'path/to/image', onClick: instance.downloadPdf, }); }); getItems() Return the array of items in the popup. Returns: Current items in the popup. Type Array.&lt;object&gt; Example WebViewer(...) .then(function(instance) { instance.annotationPopup.getItems(); }); update( [items]) Update all the items in the popup. To update an individual item, use updateElement Parameters: Name Type Argument Description items Array.&lt;object&gt; &lt;optional&gt; the items that will be rendered in the popup Returns: The instance itself Type this Example WebViewer(...) .then(function(instance) { // replace existing items with a new array of items instance.contextMenuPopup.update([ { type: 'actionButton', img: 'path/to/image', onClick: instance.downloadPdf, }, { type: 'actionButton', img: 'path/to/image', onClick: instance.print, }, ]); }); Interface: Popup UI. Popup A class which contains popup APIs. ⚠ If you want to remove an item in a popup, use disableElements. Methods add(items [, dataElement]) Add an array of items after the item that has the given data element. Parameters: Name Type Argument Description items Array.&lt;object&gt; Same as header items dataElement string &lt;optional&gt; An optional string. If not given, items will be added in the beginning Returns: The instance itself Type this Example WebViewer(...) .then(function(instance) { instance.contextMenuPopup.add({ type: 'actionButton', img: 'path/to/image', onClick: instance.downloadPdf, }); }); getItems() Return the array of items in the popup. Returns: Current items in the popup. Type Array.&lt;object&gt; Example WebViewer(...) .then(function(instance) { instance.annotationPopup.getItems(); }); update( [items]) Update all the items in the popup. To update an individual item, use updateElement Parameters: Name Type Argument Description items Array.&lt;object&gt; &lt;optional&gt; the items that will be rendered in the popup Returns: The instance itself Type this Example WebViewer(...) .then(function(instance) { // replace existing items with a new array of items instance.contextMenuPopup.update([ { type: 'actionButton', img: 'path/to/image', onClick: instance.downloadPdf, }, { type: 'actionButton', img: 'path/to/image', onClick: instance.print, }, ]); }); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:50-07:00 using the DocStrap template. "},"UI.TabManager.html":{"id":"UI.TabManager.html","title":"Namespace: TabManager","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: TabManager UI. TabManager An instance of TabManager that can be used to edit the open document Tabs **Only Multi-Tab Mode**. Example WebViewer(...) .then(function (instance) { instance.UI.TabManager.setActiveTab(0); }) Methods &lt;static&gt; addTab(src [, options]) Add a new tab to the UI Parameters: Name Type Argument Description src string | File | Blob | Core.Document | Core.PDFNet.PDFDoc The source of the tab to be added (e.g. a URL, a blob, ArrayBuffer, or a File) options UI.addTabOptions &lt;optional&gt; The options for the tab to be added Returns: Resolves to the tab id of the newly added tab Type Promise.&lt;number&gt; Example WebViewer(...).then(function(instance) { instance.UI.TabManager.addTab('http://www.example.com/pdf', {extension: \"pdf\", setActive: true, saveCurrentActiveTabState: true}); // Add a new tab with the URL http://www.example.com }); &lt;static&gt; deleteTab(tabId) Delete a tab by id in the UI Parameters: Name Type Description tabId number The tab id to be deleted from the tab header Returns: Type void Example WebViewer(...).then(function(instance) { instance.UI.TabManager.deleteTab(0); // Delete tab id 0 }); &lt;static&gt; getActiveTab() Get the currently active tab id Returns: The current tab with the following properties: { id: Number, options: Object, src: string|Blob|File|ArrayBuffer } Type object &lt;static&gt; getAllTabs() Get all the tabs from the UI Returns: Array of tab objects containing the following properties: { id: Number, options: Object, src: string|Blob|File|ArrayBuffer } Type Array.&lt;Object&gt; &lt;static&gt; setActiveTab(tabId [, saveCurrentActiveTabState]) Set the currently open tab in the UI Parameters: Name Type Argument Description tabId number The tab id to set as the current tab saveCurrentActiveTabState boolean &lt;optional&gt; Whether to save the current tab annotations, scroll position, and zoom level before switching to the new tab (default: true) Returns: Resolves when the tab is loaded Type Promise.&lt;void&gt; Example WebViewer(...).then(function(instance) { instance.UI.TabManager.setActiveTab(0, false); // Set to tab id 0 discarding current tab state }); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:50-07:00 using the DocStrap template. "},"UI.ThumbnailControlMenu.html":{"id":"UI.ThumbnailControlMenu.html","title":"Interface: ThumbnailControlMenu","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Interface: ThumbnailControlMenu UI. ThumbnailControlMenu A class which contains ThumbnailControlMenu APIs. ⚠ If you want to remove an item in the ThumbnailControlMenu, use disableElements. Methods add(MenuItem [, dataElementToInsertAfter]) Adds an array of thumbnail menu buttons to the default menu. If passed a dataElement parameter, it will add the new menu buttons after this element. Otherwise, they will be appended to the start of the existing list of buttons. Parameters: Name Type Argument Description MenuItem Array.&lt;UI.ThumbnailControlMenu.MenuItem&gt; Array of buttons to be added, each with its individual operations. See example below. dataElementToInsertAfter 'thumbRotateClockwise' | 'thumbDelete' &lt;optional&gt; An optional string that determines where in the overlay the new section will be added. If not included, the new page manipulation section will be added at the top. You can call getItems to get existing items and their dataElements. Returns: The instance itself Type UI.ThumbnailControlMenu Example WebViewer(...) .then(function (instance) { instance.UI.thumbnailControlMenu.add([ { title: 'alertme', img: 'data:image/png;base64,...', onClick: (selectedPageNumbers) =&gt; { alert(`Selected thumbnail: ${selectedPageNumbers}`); }, dataElement: 'alertMeDataElement', }, ]); }) getItems() Return the array of items in the ThumbnailControlMenu. Returns: Current items in the ThumbnailControlMenu. Type Array.&lt;UI.ThumbnailControlMenu.MenuItem&gt; Example WebViewer(...) .then(function(instance) { instance.UI.ThumbnailControlMenu.getItems(); }); update(MenuItem) Update all the buttons in the ThumbnailControlMenu, essentially replacing them with a new list of buttons. To update an individual item, use updateElement Parameters: Name Type Description MenuItem Array.&lt;UI.ThumbnailControlMenu.MenuItem&gt; The list of MenuItems that will be rendered in the thumbnail menu overlay. See the add documentation for an example. Returns: The instance of itself Type UI.ThumbnailControlMenu Example WebViewer(...) .then(function (instance) { instance.UI.thumbnailControlMenu.update([ { title: 'alertme', img: 'data:image/png;base64,...', onClick: (selectedPageNumbers) =&gt; { alert(`Selected thumbnail: ${selectedPageNumbers}`); }, dataElement: 'alertMeDataElement', }, ]); }) Type Definitions MenuItem Type: object Properties: Name Type Description title string Title to be displayed for the operation img string path to image to be used as an icon for the operation onClick function onClick handler, which takes as a parameter an array of selected page numbers dataElement string Unique dataElement for this operation × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:50-07:00 using the DocStrap template. "},"UI.ThumbnailsPanel.html":{"id":"UI.ThumbnailsPanel.html","title":"Namespace: ThumbnailsPanel","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: ThumbnailsPanel UI. ThumbnailsPanel Methods &lt;static&gt; disableMultiselect() Disable multi select in the left thumbnail panel Example WebViewer(...) .then(function(instance) { instance.UI.ThumbnailsPanel.disableMultiselect(); }); &lt;static&gt; enableMultiselect() Enable multi select in the left thumbnail panel Example WebViewer(...) .then(function(instance) { instance.UI.ThumbnailsPanel.enableMultiselect(); }); &lt;static&gt; getSelectedPageNumbers() Get the currently selected pages Returns: an array of select page numbers Type Array.&lt;number&gt; Example WebViewer(...) .then(function(instance) { instance.UI.ThumbnailsPanel.getSelectedPageNumbers(); }); &lt;static&gt; selectPages(pageNumbers) Select thumbnails in the thumbnail panel. This requires the \"ThumbnailMultiselect\" feature to be enabled Parameters: Name Type Description pageNumbers Array.&lt;number&gt; array of page numbers to select Example WebViewer(...) .then(function(instance) { instance.UI.enableFeatures(['ThumbnailMultiselect']); const pageNumbersToSelect = [1, 2, 3]; instance.UI.ThumbnailsPanel.selectPages(pageNumbersToSelect); }); &lt;static&gt; setThumbnailSelectionMode(thumbnailSelectionMode) Sets thumbnail selection mode. Parameters: Name Type Description thumbnailSelectionMode string Thumbnail selection mode to set Properties Name Type Description thumbnail string Set selection mode to use entire thumbnail to select a page checkbox string (default) Set selection mode to use only checkbox to select a page Example WebViewer(...) .then(function(instance) { instance.UI.ThumbnailsPanel.setThumbnailSelectionMode('thumbnail'); }); &lt;static&gt; unselectPages(pageNumbers) Unselect selected thumbnails Parameters: Name Type Description pageNumbers Array.&lt;number&gt; array of page numbers to unselect Example WebViewer(...) .then(function(instance) { const pageNumbersToUnselect = [1, 2]; instance.UI.ThumbnailsPanel.unselectPages(pageNumbersToUnselect); }); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:50-07:00 using the DocStrap template. "},"UI.VerificationOptions.html":{"id":"UI.VerificationOptions.html","title":"Namespace: VerificationOptions","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Namespace: VerificationOptions UI. VerificationOptions NOTE: Digital Signature Verification requires the WebViewer Full API Methods &lt;static&gt; addTrustedCertificates(certificates) Loads the Public Key Certificates to be used for Digital Signature Verification. The contents of the X.509 Public Key Certificate need to encoded in a binary Distinguished Encoding Rules (DER) format, or in the plaintext Privacy-Enhanced Mail (PEM) format, which includes an appropriate header, Base64 encoded DER representing the public key certificate, and appropriate footer. Parameters: Name Type Description certificates Array.&lt;(string|File|ArrayBuffer|Int8Array|Uint8Array|Uint8ClampedArray)&gt; An array of URLs, and/or instance of the File type, and/or a Binary Array datatype that contain the X.509 Public Key Certificates to be used for validating Digital Signatures on a document. Example WebViewer(...).then(async function(instance) { const response = await fetch( 'https://mydomain.com/api/returns/certificate/as/arraybuffer' ); const certificateAsArrayBuffer = await response.arrayBuffer(); instance.UI.VerificationOptions.addTrustedCertificates([ certificateAsArrayBuffer, 'https://mydomain.com/path/to/certificate1.cer', 'https://mydomain.com/path/to/certificate2.crt', ]) }); &lt;static&gt; loadTrustList(TrustList) Loads a Trust List to be used for Digital Signature Verification. The Trust List is structured in Acrobat's FDF Data/Cert Exchange format into the VerificationOptions certificate store. Certificates inside the FDF trust list that cannot be decoded and loaded, will be skipped. Parameters: Name Type Description TrustList Blob | ArrayBuffer | Int8Array | Uint8Array | Uint8ClampedArray A buffer representation of FDF Certificate Exchange Data Example WebViewer(...).then(async function(instance) { const response = await fetch( 'https://mydomain.com/api/returns/trustList/' ); const trustListAsArrayBuffer = await response.arrayBuffer(); instance.UI.VerificationOptions.loadTrustList(trustListAsArrayBuffer); }); × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:50-07:00 using the DocStrap template. "},"WebViewerInstance.html":{"id":"WebViewerInstance.html","title":"Class: WebViewerInstance","body":" PDFJS Express WebViewer Namespaces CoreCore.ActionsCore.AnnotationsCore.ContentEditCore.MathCore.PartRetrieversCore.SearchCore.ToolsUIUI.FontsUI.HotkeysUI.NotesPanelUI.TabManagerUI.ThumbnailsPanelUI.VerificationOptions Classes Core.Actions.ActionCore.Actions.DestCore.Actions.GoToCore.Actions.GoToRCore.Actions.HideCore.Actions.JavaScriptCore.Actions.NamedCore.Actions.ResetFormCore.Actions.SubmitFormCore.Actions.URICore.AnnotationHistoryManagerCore.AnnotationManagerCore.Annotations.AnnotationCore.Annotations.ArcAnnotationCore.Annotations.BorderCore.Annotations.BoxControlHandleCore.Annotations.BoxSelectionModelCore.Annotations.ButtonWidgetAnnotationCore.Annotations.CalloutControlHandleCore.Annotations.CalloutSelectionModelCore.Annotations.CanvasHelperCore.Annotations.CaretAnnotationCore.Annotations.CheckButtonWidgetAnnotationCore.Annotations.ChoiceWidgetAnnotationCore.Annotations.ColorCore.Annotations.ControlHandleCore.Annotations.CustomAnnotationCore.Annotations.DatePickerWidgetAnnotationCore.Annotations.EllipseAnnotationCore.Annotations.FileAttachmentAnnotationCore.Annotations.FontCore.Annotations.FormsCore.Annotations.Forms.EmbeddedJSCore.Annotations.Forms.FieldCore.Annotations.Forms.FieldManagerCore.Annotations.FreeHandAnnotationCore.Annotations.FreeTextAnnotationCore.Annotations.FreeTextAnnotation.RichTextEditorCore.Annotations.FreeTextSelectionModelCore.Annotations.HTMLAnnotationCore.Annotations.IPathAnnotationCore.Annotations.LineAnnotationCore.Annotations.LineControlHandleCore.Annotations.LineSelectionModelCore.Annotations.LinkCore.Annotations.ListWidgetAnnotationCore.Annotations.MarkupAnnotationCore.Annotations.Model3DCore.Annotations.PathControlHandleCore.Annotations.PathSelectionModelCore.Annotations.PolygonAnnotationCore.Annotations.PolygonControlHandleCore.Annotations.PolygonSelectionModelCore.Annotations.PolylineAnnotationCore.Annotations.PopupAnnotationCore.Annotations.RadioButtonWidgetAnnotationCore.Annotations.RectangleAnnotationCore.Annotations.RedactionAnnotationCore.Annotations.RedactionSelectionModelCore.Annotations.RotationControlHandleCore.Annotations.RotationUtilsCore.Annotations.SelectionAlgorithmCore.Annotations.SelectionModelCore.Annotations.SignatureWidgetAnnotationCore.Annotations.SoundAnnotationCore.Annotations.StampAnnotationCore.Annotations.StickyAnnotationCore.Annotations.TextHighlightAnnotationCore.Annotations.TextMarkupAnnotationCore.Annotations.TextRedactAnnotationCore.Annotations.TextSelectionModelCore.Annotations.TextSquigglyAnnotationCore.Annotations.TextStrikeoutAnnotationCore.Annotations.TextUnderlineAnnotationCore.Annotations.TextWidgetAnnotationCore.Annotations.WidgetAnnotationCore.Annotations.WidgetFlagsCore.Annotations.XFDFUtilsCore.BookmarkCore.DisplayModeCore.DisplayModeManagerCore.DocumentCore.DocumentViewerCore.EditBoxManagerCore.EventHandlerCore.Math.MatrixCore.Math.PointCore.Math.QuadCore.Math.RectCore.Math.TransformationBuilderCore.MeasurementManagerCore.PartRetrievers.PartRetrieverCore.ScaleCore.Tools.AnnotationEditToolCore.Tools.AnnotationSelectToolCore.Tools.ArcCreateToolCore.Tools.ArcMeasurementCreateToolCore.Tools.AreaMeasurementCreateToolCore.Tools.ArrowCreateToolCore.Tools.CalloutCreateToolCore.Tools.ChangeViewCreateToolCore.Tools.CheckBoxFormFieldCreateToolCore.Tools.CloudyRectangularAreaMeasurementToolCore.Tools.ComboBoxFormFieldCreateToolCore.Tools.ContentEditToolCore.Tools.CountMeasurementCreateToolCore.Tools.DateFreeTextCreateToolCore.Tools.DistanceMeasurementCreateToolCore.Tools.EllipseCreateToolCore.Tools.EllipseMeasurementCreateToolCore.Tools.EraserToolCore.Tools.FileAttachmentCreateToolCore.Tools.FreeHandCreateToolCore.Tools.FreeHandHighlightCreateToolCore.Tools.FreeTextCreateToolCore.Tools.GenericAnnotationCreateToolCore.Tools.LineCreateToolCore.Tools.ListBoxFormFieldCreateToolCore.Tools.MarqueeZoomToolCore.Tools.PageCoordinateCore.Tools.PanToolCore.Tools.PerimeterMeasurementCreateToolCore.Tools.PolygonCloudCreateToolCore.Tools.PolygonCreateToolCore.Tools.PolylineCreateToolCore.Tools.RadioButtonFormFieldCreateToolCore.Tools.RectangleCreateToolCore.Tools.RectangularAreaMeasurementToolCore.Tools.RedactionCreateToolCore.Tools.RubberStampCreateToolCore.Tools.SignatureCreateToolCore.Tools.StampCreateToolCore.Tools.StickyCreateToolCore.Tools.TextAnnotationCreateToolCore.Tools.TextFormFieldCreateToolCore.Tools.TextHighlightCreateToolCore.Tools.TextSelectToolCore.Tools.TextSquigglyCreateToolCore.Tools.TextStrikeoutCreateToolCore.Tools.TextToolCore.Tools.TextUnderlineCreateToolCore.Tools.ToolTextHighlightAnnotationUI.HeaderUI.MentionsManagerWebViewerInstance Events Core.AnnotationHistoryManager#event:historyChangedCore.AnnotationManager#event:addReplyCore.AnnotationManager#event:annotationChangedCore.AnnotationManager#event:annotationDeselectedCore.AnnotationManager#event:annotationDoubleClickedCore.AnnotationManager#event:annotationHiddenCore.AnnotationManager#event:annotationsDrawnCore.AnnotationManager#event:annotationSelectedCore.AnnotationManager#event:deleteReplyCore.AnnotationManager#event:fieldChangedCore.AnnotationManager#event:fileAttachmentDataAvailableCore.AnnotationManager#event:setNoteTextCore.AnnotationManager#event:updateAnnotationPermissionCore.Annotations.Forms.Field#event:calculateCore.Annotations.Forms.Field#event:changeCore.Annotations.Forms.Field#event:commitCore.ContentEdit#event:editBoxesAvailableCore.ContentEdit#event:textContentUpdatedCore.Document#event:colorSeparationAddedCore.Document#event:layersUpdatedCore.DocumentViewer#event:activeSearchResultChangedCore.DocumentViewer#event:annotationsLoadedCore.DocumentViewer#event:beforeDocumentLoadedCore.DocumentViewer#event:beginRenderingCore.DocumentViewer#event:clickCore.DocumentViewer#event:dblClickCore.DocumentViewer#event:displayModeUpdatedCore.DocumentViewer#event:displayPageLocationCore.DocumentViewer#event:documentLoadedCore.DocumentViewer#event:documentUnloadedCore.DocumentViewer#event:embeddedThumbnailCompleteCore.DocumentViewer#event:finishedRenderingCore.DocumentViewer#event:fitModeUpdatedCore.DocumentViewer#event:keyDownCore.DocumentViewer#event:keyUpCore.DocumentViewer#event:mouseEnterCore.DocumentViewer#event:mouseLeaveCore.DocumentViewer#event:mouseLeftDownCore.DocumentViewer#event:mouseLeftUpCore.DocumentViewer#event:mouseMoveCore.DocumentViewer#event:mouseRightDownCore.DocumentViewer#event:mouseRightUpCore.DocumentViewer#event:notifyCore.DocumentViewer#event:pageCompleteCore.DocumentViewer#event:pageNumberUpdatedCore.DocumentViewer#event:pagesUpdatedCore.DocumentViewer#event:rotationUpdatedCore.DocumentViewer#event:searchInProgressCore.DocumentViewer#event:searchResultsChangedCore.DocumentViewer#event:tapCore.DocumentViewer#event:textSelectedCore.DocumentViewer#event:toolModeUpdatedCore.DocumentViewer#event:toolUpdatedCore.DocumentViewer#event:zoomUpdatedCore.EditBoxManager#event:editorBlurCore.EditBoxManager#event:editorFocusCore.EditBoxManager#event:editorSelectionChangedCore.EditBoxManager#event:editorTextChangedCore.MeasurementManager#event:scaleUpdatedCore.Tools.ArcCreateTool#event:annotationAddedCore.Tools.ArcCreateTool#event:annotationCreatedCore.Tools.ArcMeasurementCreateTool#event:annotationAddedCore.Tools.ArcMeasurementCreateTool#event:annotationCreatedCore.Tools.AreaMeasurementCreateTool#event:annotationAddedCore.Tools.AreaMeasurementCreateTool#event:annotationCreatedCore.Tools.ArrowCreateTool#event:annotationAddedCore.Tools.ArrowCreateTool#event:annotationCreatedCore.Tools.CalloutCreateTool#event:annotationAddedCore.Tools.CalloutCreateTool#event:annotationCreatedCore.Tools.ChangeViewCreateTool#event:annotationAddedCore.Tools.ChangeViewCreateTool#event:annotationCreatedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationAddedCore.Tools.CheckBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAddedCore.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ComboBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.CountMeasurementCreateTool#event:annotationAddedCore.Tools.CountMeasurementCreateTool#event:annotationCreatedCore.Tools.CropCreateTool#event:cropAppliedCore.Tools.DateFreeTextCreateTool#event:annotationAddedCore.Tools.DateFreeTextCreateTool#event:annotationCreatedCore.Tools.DistanceMeasurementCreateTool#event:annotationAddedCore.Tools.DistanceMeasurementCreateTool#event:annotationCreatedCore.Tools.EllipseCreateTool#event:annotationAddedCore.Tools.EllipseCreateTool#event:annotationCreatedCore.Tools.EllipseMeasurementCreateTool#event:annotationAddedCore.Tools.EllipseMeasurementCreateTool#event:annotationCreatedCore.Tools.EraserTool#event:annotationAddedCore.Tools.EraserTool#event:annotationCreatedCore.Tools.EraserTool#event:erasingAnnotationCore.Tools.FreeHandCreateTool#event:annotationAddedCore.Tools.FreeHandCreateTool#event:annotationCreatedCore.Tools.FreeHandHighlightCreateTool#event:annotationAddedCore.Tools.FreeHandHighlightCreateTool#event:annotationCreatedCore.Tools.FreeTextCreateTool#event:annotationAddedCore.Tools.FreeTextCreateTool#event:annotationCreatedCore.Tools.GenericAnnotationCreateTool#event:annotationAddedCore.Tools.GenericAnnotationCreateTool#event:annotationCreatedCore.Tools.LineCreateTool#event:annotationAddedCore.Tools.LineCreateTool#event:annotationCreatedCore.Tools.ListBoxFormFieldCreateTool#event:annotationAddedCore.Tools.ListBoxFormFieldCreateTool#event:annotationCreatedCore.Tools.PerimeterMeasurementCreateTool#event:annotationAddedCore.Tools.PerimeterMeasurementCreateTool#event:annotationCreatedCore.Tools.PolygonCloudCreateTool#event:annotationAddedCore.Tools.PolygonCloudCreateTool#event:annotationCreatedCore.Tools.PolygonCreateTool#event:annotationAddedCore.Tools.PolygonCreateTool#event:annotationCreatedCore.Tools.PolylineCreateTool#event:annotationAddedCore.Tools.PolylineCreateTool#event:annotationCreatedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationAddedCore.Tools.RadioButtonFormFieldCreateTool#event:annotationCreatedCore.Tools.RectangleCreateTool#event:annotationAddedCore.Tools.RectangleCreateTool#event:annotationCreatedCore.Tools.RectangularAreaMeasurementTool#event:annotationAddedCore.Tools.RectangularAreaMeasurementTool#event:annotationCreatedCore.Tools.RedactionCreateTool#event:annotationAddedCore.Tools.RedactionCreateTool#event:annotationCreatedCore.Tools.RubberStampCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:annotationAddedCore.Tools.SignatureCreateTool#event:fileRejectedCore.Tools.SignatureCreateTool#event:locationSelectedCore.Tools.SignatureCreateTool#event:signatureDeletedCore.Tools.SignatureCreateTool#event:signatureSavedCore.Tools.StampCreateTool#event:annotationAddedCore.Tools.StampCreateTool#event:fileRejectedCore.Tools.StickyCreateTool#event:annotationAddedCore.Tools.StickyCreateTool#event:annotationCreatedCore.Tools.TextAnnotationCreateTool#event:annotationAddedCore.Tools.TextAnnotationCreateTool#event:annotationCreatedCore.Tools.TextFormFieldCreateTool#event:annotationAddedCore.Tools.TextFormFieldCreateTool#event:annotationCreatedCore.Tools.TextHighlightCreateTool#event:annotationAddedCore.Tools.TextHighlightCreateTool#event:annotationCreatedCore.Tools.TextSelectTool#event:selectionCompleteCore.Tools.TextSquigglyCreateTool#event:annotationAddedCore.Tools.TextSquigglyCreateTool#event:annotationCreatedCore.Tools.TextStrikeoutCreateTool#event:annotationAddedCore.Tools.TextStrikeoutCreateTool#event:annotationCreatedCore.Tools.TextUnderlineCreateTool#event:annotationAddedCore.Tools.TextUnderlineCreateTool#event:annotationCreatedUI.MentionsManager#event:mentionChangedUI#event:annotationFilterChangedUI#event:beforeTabChangedUI#event:documentLoadedUI#event:documentMergedUI#event:dragOutlineUI#event:fileDownloadedUI#event:finishedSavingPDFUI#event:fullscreenModeToggledUI#event:loaderrorUI#event:outlineBookmarksChangedUI#event:panelResizedUI#event:selectedThumbnailChangedUI#event:tabAddedUI#event:tabDeletedUI#event:tabMovedUI#event:themeChangedUI#event:thumbnailDraggedUI#event:thumbnailDroppedUI#event:toolbarGroupChangedUI#event:userBookmarksChangedUI#event:viewerLoadedUI#event:visibilityChanged Global getInstanceWebViewer Class: WebViewerInstance WebViewerInstance new WebViewerInstance() A single instance of webviewer. Can be retrieved from the global WebViewer function. This class is not instantiable. Members Core Core namespace on WebViewer instance Type: Class.&lt;Core&gt; See: Core Example WebViewer({...options}, document.getElementById('viewer')) .then(webviewerInstance =&gt; { webViewerInstance.Core }) UI UI namespace on WebViewer instance Type: Class.&lt;UI&gt; See: UI Example WebViewer({...options}, document.getElementById('viewer')) .then(webviewerInstance =&gt; { webViewerInstance.UI }) × Search results Close Documentation generated by JSDoc 3.6.10 on 2023-06-16T14:56:50-07:00 using the DocStrap template. "}}
    </script>

    <script type="text/javascript">
        $(document).ready(function() {
            Searcher.init();
        });

        $(window).on("message", function(msg) {
            var msgData = msg.originalEvent.data;

            if (msgData.msgid != "docstrap.quicksearch.start") {
                return;
            }

            var results = Searcher.search(msgData.searchTerms);

            window.parent.postMessage({"results": results, "msgid": "docstrap.quicksearch.done"}, "*");
        });
    </script>
</body>
</html>

Anon7 - 2022
AnonSec Team