| Server IP : 212.252.79.165 / Your IP : 216.73.217.172 [ Web Server : Apache System : Linux 212-252-79-165.cprapid.com 5.15.0-153-generic #163-Ubuntu SMP Thu Aug 7 16:37:18 UTC 2025 x86_64 User : cehaburo ( 1001) PHP Version : 8.1.33 Disable Function : exec,passthru,shell_exec,system Domains : 48 Domains MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /home/cehaburo/www/pdfjs/doc/ |
Upload File : |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>PDFJS Express WebViewer Namespace: Core</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.pdftron.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top ">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">PDFJS Express WebViewer</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="Core.html">Core</a></li><li><a href="Core.Actions.html">Core.Actions</a></li><li><a href="Core.Annotations.html">Core.Annotations</a></li><li><a href="Core.ContentEdit.html">Core.ContentEdit</a></li><li><a href="Core.Math.html">Core.Math</a></li><li><a href="Core.PartRetrievers.html">Core.PartRetrievers</a></li><li><a href="Core.Search.html">Core.Search</a></li><li><a href="Core.Tools.html">Core.Tools</a></li><li><a href="UI.html">UI</a></li><li><a href="UI.Fonts.html">UI.Fonts</a></li><li><a href="UI.Hotkeys.html">UI.Hotkeys</a></li><li><a href="UI.NotesPanel.html">UI.NotesPanel</a></li><li><a href="UI.TabManager.html">UI.TabManager</a></li><li><a href="UI.ThumbnailsPanel.html">UI.ThumbnailsPanel</a></li><li><a href="UI.VerificationOptions.html">UI.VerificationOptions</a></li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="Core.Actions.Action.html">Core.Actions.Action</a></li><li><a href="Core.Actions.Dest.html">Core.Actions.Dest</a></li><li><a href="Core.Actions.GoTo.html">Core.Actions.GoTo</a></li><li><a href="Core.Actions.GoToR.html">Core.Actions.GoToR</a></li><li><a href="Core.Actions.Hide.html">Core.Actions.Hide</a></li><li><a href="Core.Actions.JavaScript.html">Core.Actions.JavaScript</a></li><li><a href="Core.Actions.Named.html">Core.Actions.Named</a></li><li><a href="Core.Actions.ResetForm.html">Core.Actions.ResetForm</a></li><li><a href="Core.Actions.SubmitForm.html">Core.Actions.SubmitForm</a></li><li><a href="Core.Actions.URI.html">Core.Actions.URI</a></li><li><a href="Core.AnnotationHistoryManager.html">Core.AnnotationHistoryManager</a></li><li><a href="Core.AnnotationManager.html">Core.AnnotationManager</a></li><li><a href="Core.Annotations.Annotation.html">Core.Annotations.Annotation</a></li><li><a href="Core.Annotations.ArcAnnotation.html">Core.Annotations.ArcAnnotation</a></li><li><a href="Core.Annotations.Border.html">Core.Annotations.Border</a></li><li><a href="Core.Annotations.BoxControlHandle.html">Core.Annotations.BoxControlHandle</a></li><li><a href="Core.Annotations.BoxSelectionModel.html">Core.Annotations.BoxSelectionModel</a></li><li><a href="Core.Annotations.ButtonWidgetAnnotation.html">Core.Annotations.ButtonWidgetAnnotation</a></li><li><a href="Core.Annotations.CalloutControlHandle.html">Core.Annotations.CalloutControlHandle</a></li><li><a href="Core.Annotations.CalloutSelectionModel.html">Core.Annotations.CalloutSelectionModel</a></li><li><a href="Core.Annotations.CanvasHelper.html">Core.Annotations.CanvasHelper</a></li><li><a href="Core.Annotations.CaretAnnotation.html">Core.Annotations.CaretAnnotation</a></li><li><a href="Core.Annotations.CheckButtonWidgetAnnotation.html">Core.Annotations.CheckButtonWidgetAnnotation</a></li><li><a href="Core.Annotations.ChoiceWidgetAnnotation.html">Core.Annotations.ChoiceWidgetAnnotation</a></li><li><a href="Core.Annotations.Color.html">Core.Annotations.Color</a></li><li><a href="Core.Annotations.ControlHandle.html">Core.Annotations.ControlHandle</a></li><li><a href="Core.Annotations.CustomAnnotation.html">Core.Annotations.CustomAnnotation</a></li><li><a href="Core.Annotations.DatePickerWidgetAnnotation.html">Core.Annotations.DatePickerWidgetAnnotation</a></li><li><a href="Core.Annotations.EllipseAnnotation.html">Core.Annotations.EllipseAnnotation</a></li><li><a href="Core.Annotations.FileAttachmentAnnotation.html">Core.Annotations.FileAttachmentAnnotation</a></li><li><a href="Core.Annotations.Font.html">Core.Annotations.Font</a></li><li><a href="Core.Annotations.Forms.html">Core.Annotations.Forms</a></li><li><a href="Core.Annotations.Forms.EmbeddedJS.html">Core.Annotations.Forms.EmbeddedJS</a></li><li><a href="Core.Annotations.Forms.Field.html">Core.Annotations.Forms.Field</a></li><li><a href="Core.Annotations.Forms.FieldManager.html">Core.Annotations.Forms.FieldManager</a></li><li><a href="Core.Annotations.FreeHandAnnotation.html">Core.Annotations.FreeHandAnnotation</a></li><li><a href="Core.Annotations.FreeTextAnnotation.html">Core.Annotations.FreeTextAnnotation</a></li><li><a href="Core.Annotations.FreeTextAnnotation.RichTextEditor.html">Core.Annotations.FreeTextAnnotation.RichTextEditor</a></li><li><a href="Core.Annotations.FreeTextSelectionModel.html">Core.Annotations.FreeTextSelectionModel</a></li><li><a href="Core.Annotations.HTMLAnnotation.html">Core.Annotations.HTMLAnnotation</a></li><li><a href="Core.Annotations.IPathAnnotation.html">Core.Annotations.IPathAnnotation</a></li><li><a href="Core.Annotations.LineAnnotation.html">Core.Annotations.LineAnnotation</a></li><li><a href="Core.Annotations.LineControlHandle.html">Core.Annotations.LineControlHandle</a></li><li><a href="Core.Annotations.LineSelectionModel.html">Core.Annotations.LineSelectionModel</a></li><li><a href="Core.Annotations.Link.html">Core.Annotations.Link</a></li><li><a href="Core.Annotations.ListWidgetAnnotation.html">Core.Annotations.ListWidgetAnnotation</a></li><li><a href="Core.Annotations.MarkupAnnotation.html">Core.Annotations.MarkupAnnotation</a></li><li><a href="Core.Annotations.Model3D.html">Core.Annotations.Model3D</a></li><li><a href="Core.Annotations.PathControlHandle.html">Core.Annotations.PathControlHandle</a></li><li><a href="Core.Annotations.PathSelectionModel.html">Core.Annotations.PathSelectionModel</a></li><li><a href="Core.Annotations.PolygonAnnotation.html">Core.Annotations.PolygonAnnotation</a></li><li><a href="Core.Annotations.PolygonControlHandle.html">Core.Annotations.PolygonControlHandle</a></li><li><a href="Core.Annotations.PolygonSelectionModel.html">Core.Annotations.PolygonSelectionModel</a></li><li><a href="Core.Annotations.PolylineAnnotation.html">Core.Annotations.PolylineAnnotation</a></li><li><a href="Core.Annotations.PopupAnnotation.html">Core.Annotations.PopupAnnotation</a></li><li><a href="Core.Annotations.RadioButtonWidgetAnnotation.html">Core.Annotations.RadioButtonWidgetAnnotation</a></li><li><a href="Core.Annotations.RectangleAnnotation.html">Core.Annotations.RectangleAnnotation</a></li><li><a href="Core.Annotations.RedactionAnnotation.html">Core.Annotations.RedactionAnnotation</a></li><li><a href="Core.Annotations.RedactionSelectionModel.html">Core.Annotations.RedactionSelectionModel</a></li><li><a href="Core.Annotations.RotationControlHandle.html">Core.Annotations.RotationControlHandle</a></li><li><a href="Core.Annotations.RotationUtils.html">Core.Annotations.RotationUtils</a></li><li><a href="Core.Annotations.SelectionAlgorithm.html">Core.Annotations.SelectionAlgorithm</a></li><li><a href="Core.Annotations.SelectionModel.html">Core.Annotations.SelectionModel</a></li><li><a href="Core.Annotations.SignatureWidgetAnnotation.html">Core.Annotations.SignatureWidgetAnnotation</a></li><li><a href="Core.Annotations.SoundAnnotation.html">Core.Annotations.SoundAnnotation</a></li><li><a href="Core.Annotations.StampAnnotation.html">Core.Annotations.StampAnnotation</a></li><li><a href="Core.Annotations.StickyAnnotation.html">Core.Annotations.StickyAnnotation</a></li><li><a href="Core.Annotations.TextHighlightAnnotation.html">Core.Annotations.TextHighlightAnnotation</a></li><li><a href="Core.Annotations.TextMarkupAnnotation.html">Core.Annotations.TextMarkupAnnotation</a></li><li><a href="Core.Annotations.TextRedactAnnotation.html">Core.Annotations.TextRedactAnnotation</a></li><li><a href="Core.Annotations.TextSelectionModel.html">Core.Annotations.TextSelectionModel</a></li><li><a href="Core.Annotations.TextSquigglyAnnotation.html">Core.Annotations.TextSquigglyAnnotation</a></li><li><a href="Core.Annotations.TextStrikeoutAnnotation.html">Core.Annotations.TextStrikeoutAnnotation</a></li><li><a href="Core.Annotations.TextUnderlineAnnotation.html">Core.Annotations.TextUnderlineAnnotation</a></li><li><a href="Core.Annotations.TextWidgetAnnotation.html">Core.Annotations.TextWidgetAnnotation</a></li><li><a href="Core.Annotations.WidgetAnnotation.html">Core.Annotations.WidgetAnnotation</a></li><li><a href="Core.Annotations.WidgetFlags.html">Core.Annotations.WidgetFlags</a></li><li><a href="Core.Annotations.XFDFUtils.html">Core.Annotations.XFDFUtils</a></li><li><a href="Core.Bookmark.html">Core.Bookmark</a></li><li><a href="Core.DisplayMode.html">Core.DisplayMode</a></li><li><a href="Core.DisplayModeManager.html">Core.DisplayModeManager</a></li><li><a href="Core.Document.html">Core.Document</a></li><li><a href="Core.DocumentViewer.html">Core.DocumentViewer</a></li><li><a href="Core.EditBoxManager.html">Core.EditBoxManager</a></li><li><a href="Core.EventHandler.html">Core.EventHandler</a></li><li><a href="Core.Math.Matrix.html">Core.Math.Matrix</a></li><li><a href="Core.Math.Point.html">Core.Math.Point</a></li><li><a href="Core.Math.Quad.html">Core.Math.Quad</a></li><li><a href="Core.Math.Rect.html">Core.Math.Rect</a></li><li><a href="Core.Math.TransformationBuilder.html">Core.Math.TransformationBuilder</a></li><li><a href="Core.MeasurementManager.html">Core.MeasurementManager</a></li><li><a href="Core.PartRetrievers.PartRetriever.html">Core.PartRetrievers.PartRetriever</a></li><li><a href="Core.Scale.html">Core.Scale</a></li><li><a href="Core.Tools.AnnotationEditTool.html">Core.Tools.AnnotationEditTool</a></li><li><a href="Core.Tools.AnnotationSelectTool.html">Core.Tools.AnnotationSelectTool</a></li><li><a href="Core.Tools.ArcCreateTool.html">Core.Tools.ArcCreateTool</a></li><li><a href="Core.Tools.ArcMeasurementCreateTool.html">Core.Tools.ArcMeasurementCreateTool</a></li><li><a href="Core.Tools.AreaMeasurementCreateTool.html">Core.Tools.AreaMeasurementCreateTool</a></li><li><a href="Core.Tools.ArrowCreateTool.html">Core.Tools.ArrowCreateTool</a></li><li><a href="Core.Tools.CalloutCreateTool.html">Core.Tools.CalloutCreateTool</a></li><li><a href="Core.Tools.ChangeViewCreateTool.html">Core.Tools.ChangeViewCreateTool</a></li><li><a href="Core.Tools.CheckBoxFormFieldCreateTool.html">Core.Tools.CheckBoxFormFieldCreateTool</a></li><li><a href="Core.Tools.CloudyRectangularAreaMeasurementTool.html">Core.Tools.CloudyRectangularAreaMeasurementTool</a></li><li><a href="Core.Tools.ComboBoxFormFieldCreateTool.html">Core.Tools.ComboBoxFormFieldCreateTool</a></li><li><a href="Core.Tools.ContentEditTool.html">Core.Tools.ContentEditTool</a></li><li><a href="Core.Tools.CountMeasurementCreateTool.html">Core.Tools.CountMeasurementCreateTool</a></li><li><a href="Core.Tools.DateFreeTextCreateTool.html">Core.Tools.DateFreeTextCreateTool</a></li><li><a href="Core.Tools.DistanceMeasurementCreateTool.html">Core.Tools.DistanceMeasurementCreateTool</a></li><li><a href="Core.Tools.EllipseCreateTool.html">Core.Tools.EllipseCreateTool</a></li><li><a href="Core.Tools.EllipseMeasurementCreateTool.html">Core.Tools.EllipseMeasurementCreateTool</a></li><li><a href="Core.Tools.EraserTool.html">Core.Tools.EraserTool</a></li><li><a href="Core.Tools.FileAttachmentCreateTool.html">Core.Tools.FileAttachmentCreateTool</a></li><li><a href="Core.Tools.FreeHandCreateTool.html">Core.Tools.FreeHandCreateTool</a></li><li><a href="Core.Tools.FreeHandHighlightCreateTool.html">Core.Tools.FreeHandHighlightCreateTool</a></li><li><a href="Core.Tools.FreeTextCreateTool.html">Core.Tools.FreeTextCreateTool</a></li><li><a href="Core.Tools.GenericAnnotationCreateTool.html">Core.Tools.GenericAnnotationCreateTool</a></li><li><a href="Core.Tools.LineCreateTool.html">Core.Tools.LineCreateTool</a></li><li><a href="Core.Tools.ListBoxFormFieldCreateTool.html">Core.Tools.ListBoxFormFieldCreateTool</a></li><li><a href="Core.Tools.MarqueeZoomTool.html">Core.Tools.MarqueeZoomTool</a></li><li><a href="Core.Tools.PageCoordinate.html">Core.Tools.PageCoordinate</a></li><li><a href="Core.Tools.PanTool.html">Core.Tools.PanTool</a></li><li><a href="Core.Tools.PerimeterMeasurementCreateTool.html">Core.Tools.PerimeterMeasurementCreateTool</a></li><li><a href="Core.Tools.PolygonCloudCreateTool.html">Core.Tools.PolygonCloudCreateTool</a></li><li><a href="Core.Tools.PolygonCreateTool.html">Core.Tools.PolygonCreateTool</a></li><li><a href="Core.Tools.PolylineCreateTool.html">Core.Tools.PolylineCreateTool</a></li><li><a href="Core.Tools.RadioButtonFormFieldCreateTool.html">Core.Tools.RadioButtonFormFieldCreateTool</a></li><li><a href="Core.Tools.RectangleCreateTool.html">Core.Tools.RectangleCreateTool</a></li><li><a href="Core.Tools.RectangularAreaMeasurementTool.html">Core.Tools.RectangularAreaMeasurementTool</a></li><li><a href="Core.Tools.RedactionCreateTool.html">Core.Tools.RedactionCreateTool</a></li><li><a href="Core.Tools.RubberStampCreateTool.html">Core.Tools.RubberStampCreateTool</a></li><li><a href="Core.Tools.SignatureCreateTool.html">Core.Tools.SignatureCreateTool</a></li><li><a href="Core.Tools.StampCreateTool.html">Core.Tools.StampCreateTool</a></li><li><a href="Core.Tools.StickyCreateTool.html">Core.Tools.StickyCreateTool</a></li><li><a href="Core.Tools.TextAnnotationCreateTool.html">Core.Tools.TextAnnotationCreateTool</a></li><li><a href="Core.Tools.TextFormFieldCreateTool.html">Core.Tools.TextFormFieldCreateTool</a></li><li><a href="Core.Tools.TextHighlightCreateTool.html">Core.Tools.TextHighlightCreateTool</a></li><li><a href="Core.Tools.TextSelectTool.html">Core.Tools.TextSelectTool</a></li><li><a href="Core.Tools.TextSquigglyCreateTool.html">Core.Tools.TextSquigglyCreateTool</a></li><li><a href="Core.Tools.TextStrikeoutCreateTool.html">Core.Tools.TextStrikeoutCreateTool</a></li><li><a href="Core.Tools.TextTool.html">Core.Tools.TextTool</a></li><li><a href="Core.Tools.TextUnderlineCreateTool.html">Core.Tools.TextUnderlineCreateTool</a></li><li><a href="Core.Tools.Tool.html">Core.Tools.Tool</a></li><li><a href="TextHighlightAnnotation.html">TextHighlightAnnotation</a></li><li><a href="UI.Header.html">UI.Header</a></li><li><a href="UI.MentionsManager.html">UI.MentionsManager</a></li><li><a href="WebViewerInstance.html">WebViewerInstance</a></li>
</ul>
</li>
<li class="dropdown">
<a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="Core.AnnotationHistoryManager.html#event:historyChanged">Core.AnnotationHistoryManager#event:historyChanged</a></li><li><a href="Core.AnnotationManager.html#event:addReply">Core.AnnotationManager#event:addReply</a></li><li><a href="Core.AnnotationManager.html#event:annotationChanged">Core.AnnotationManager#event:annotationChanged</a></li><li><a href="Core.AnnotationManager.html#event:annotationDeselected">Core.AnnotationManager#event:annotationDeselected</a></li><li><a href="Core.AnnotationManager.html#event:annotationDoubleClicked">Core.AnnotationManager#event:annotationDoubleClicked</a></li><li><a href="Core.AnnotationManager.html#event:annotationHidden">Core.AnnotationManager#event:annotationHidden</a></li><li><a href="Core.AnnotationManager.html#event:annotationsDrawn">Core.AnnotationManager#event:annotationsDrawn</a></li><li><a href="Core.AnnotationManager.html#event:annotationSelected">Core.AnnotationManager#event:annotationSelected</a></li><li><a href="Core.AnnotationManager.html#event:deleteReply">Core.AnnotationManager#event:deleteReply</a></li><li><a href="Core.AnnotationManager.html#event:fieldChanged">Core.AnnotationManager#event:fieldChanged</a></li><li><a href="Core.AnnotationManager.html#event:fileAttachmentDataAvailable">Core.AnnotationManager#event:fileAttachmentDataAvailable</a></li><li><a href="Core.AnnotationManager.html#event:setNoteText">Core.AnnotationManager#event:setNoteText</a></li><li><a href="Core.AnnotationManager.html#event:updateAnnotationPermission">Core.AnnotationManager#event:updateAnnotationPermission</a></li><li><a href="Core.Annotations.Forms.Field.html#event:calculate">Core.Annotations.Forms.Field#event:calculate</a></li><li><a href="Core.Annotations.Forms.Field.html#event:change">Core.Annotations.Forms.Field#event:change</a></li><li><a href="Core.Annotations.Forms.Field.html#event:commit">Core.Annotations.Forms.Field#event:commit</a></li><li><a href="Core.ContentEdit.html#event:editBoxesAvailable">Core.ContentEdit#event:editBoxesAvailable</a></li><li><a href="Core.ContentEdit.html#event:textContentUpdated">Core.ContentEdit#event:textContentUpdated</a></li><li><a href="Core.Document.html#event:colorSeparationAdded">Core.Document#event:colorSeparationAdded</a></li><li><a href="Core.Document.html#event:layersUpdated">Core.Document#event:layersUpdated</a></li><li><a href="Core.DocumentViewer.html#event:activeSearchResultChanged">Core.DocumentViewer#event:activeSearchResultChanged</a></li><li><a href="Core.DocumentViewer.html#event:annotationsLoaded">Core.DocumentViewer#event:annotationsLoaded</a></li><li><a href="Core.DocumentViewer.html#event:beforeDocumentLoaded">Core.DocumentViewer#event:beforeDocumentLoaded</a></li><li><a href="Core.DocumentViewer.html#event:beginRendering">Core.DocumentViewer#event:beginRendering</a></li><li><a href="Core.DocumentViewer.html#event:click">Core.DocumentViewer#event:click</a></li><li><a href="Core.DocumentViewer.html#event:dblClick">Core.DocumentViewer#event:dblClick</a></li><li><a href="Core.DocumentViewer.html#event:displayModeUpdated">Core.DocumentViewer#event:displayModeUpdated</a></li><li><a href="Core.DocumentViewer.html#event:displayPageLocation">Core.DocumentViewer#event:displayPageLocation</a></li><li><a href="Core.DocumentViewer.html#event:documentLoaded">Core.DocumentViewer#event:documentLoaded</a></li><li><a href="Core.DocumentViewer.html#event:documentUnloaded">Core.DocumentViewer#event:documentUnloaded</a></li><li><a href="Core.DocumentViewer.html#event:embeddedThumbnailComplete">Core.DocumentViewer#event:embeddedThumbnailComplete</a></li><li><a href="Core.DocumentViewer.html#event:finishedRendering">Core.DocumentViewer#event:finishedRendering</a></li><li><a href="Core.DocumentViewer.html#event:fitModeUpdated">Core.DocumentViewer#event:fitModeUpdated</a></li><li><a href="Core.DocumentViewer.html#event:keyDown">Core.DocumentViewer#event:keyDown</a></li><li><a href="Core.DocumentViewer.html#event:keyUp">Core.DocumentViewer#event:keyUp</a></li><li><a href="Core.DocumentViewer.html#event:mouseEnter">Core.DocumentViewer#event:mouseEnter</a></li><li><a href="Core.DocumentViewer.html#event:mouseLeave">Core.DocumentViewer#event:mouseLeave</a></li><li><a href="Core.DocumentViewer.html#event:mouseLeftDown">Core.DocumentViewer#event:mouseLeftDown</a></li><li><a href="Core.DocumentViewer.html#event:mouseLeftUp">Core.DocumentViewer#event:mouseLeftUp</a></li><li><a href="Core.DocumentViewer.html#event:mouseMove">Core.DocumentViewer#event:mouseMove</a></li><li><a href="Core.DocumentViewer.html#event:mouseRightDown">Core.DocumentViewer#event:mouseRightDown</a></li><li><a href="Core.DocumentViewer.html#event:mouseRightUp">Core.DocumentViewer#event:mouseRightUp</a></li><li><a href="Core.DocumentViewer.html#event:notify">Core.DocumentViewer#event:notify</a></li><li><a href="Core.DocumentViewer.html#event:pageComplete">Core.DocumentViewer#event:pageComplete</a></li><li><a href="Core.DocumentViewer.html#event:pageNumberUpdated">Core.DocumentViewer#event:pageNumberUpdated</a></li><li><a href="Core.DocumentViewer.html#event:pagesUpdated">Core.DocumentViewer#event:pagesUpdated</a></li><li><a href="Core.DocumentViewer.html#event:rotationUpdated">Core.DocumentViewer#event:rotationUpdated</a></li><li><a href="Core.DocumentViewer.html#event:searchInProgress">Core.DocumentViewer#event:searchInProgress</a></li><li><a href="Core.DocumentViewer.html#event:searchResultsChanged">Core.DocumentViewer#event:searchResultsChanged</a></li><li><a href="Core.DocumentViewer.html#event:tap">Core.DocumentViewer#event:tap</a></li><li><a href="Core.DocumentViewer.html#event:textSelected">Core.DocumentViewer#event:textSelected</a></li><li><a href="Core.DocumentViewer.html#event:toolModeUpdated">Core.DocumentViewer#event:toolModeUpdated</a></li><li><a href="Core.DocumentViewer.html#event:toolUpdated">Core.DocumentViewer#event:toolUpdated</a></li><li><a href="Core.DocumentViewer.html#event:zoomUpdated">Core.DocumentViewer#event:zoomUpdated</a></li><li><a href="Core.EditBoxManager.html#event:editorBlur">Core.EditBoxManager#event:editorBlur</a></li><li><a href="Core.EditBoxManager.html#event:editorFocus">Core.EditBoxManager#event:editorFocus</a></li><li><a href="Core.EditBoxManager.html#event:editorSelectionChanged">Core.EditBoxManager#event:editorSelectionChanged</a></li><li><a href="Core.EditBoxManager.html#event:editorTextChanged">Core.EditBoxManager#event:editorTextChanged</a></li><li><a href="Core.MeasurementManager.html#event:scaleUpdated">Core.MeasurementManager#event:scaleUpdated</a></li><li><a href="Core.Tools.ArcCreateTool.html#event:annotationAdded">Core.Tools.ArcCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.ArcCreateTool.html#event:annotationCreated">Core.Tools.ArcCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.ArcMeasurementCreateTool.html#event:annotationAdded">Core.Tools.ArcMeasurementCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.ArcMeasurementCreateTool.html#event:annotationCreated">Core.Tools.ArcMeasurementCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.AreaMeasurementCreateTool.html#event:annotationAdded">Core.Tools.AreaMeasurementCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.AreaMeasurementCreateTool.html#event:annotationCreated">Core.Tools.AreaMeasurementCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.ArrowCreateTool.html#event:annotationAdded">Core.Tools.ArrowCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.ArrowCreateTool.html#event:annotationCreated">Core.Tools.ArrowCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.CalloutCreateTool.html#event:annotationAdded">Core.Tools.CalloutCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.CalloutCreateTool.html#event:annotationCreated">Core.Tools.CalloutCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.ChangeViewCreateTool.html#event:annotationAdded">Core.Tools.ChangeViewCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.ChangeViewCreateTool.html#event:annotationCreated">Core.Tools.ChangeViewCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.CheckBoxFormFieldCreateTool.html#event:annotationAdded">Core.Tools.CheckBoxFormFieldCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.CheckBoxFormFieldCreateTool.html#event:annotationCreated">Core.Tools.CheckBoxFormFieldCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.CloudyRectangularAreaMeasurementTool.html#event:annotationAdded">Core.Tools.CloudyRectangularAreaMeasurementTool#event:annotationAdded</a></li><li><a href="Core.Tools.CloudyRectangularAreaMeasurementTool.html#event:annotationCreated">Core.Tools.CloudyRectangularAreaMeasurementTool#event:annotationCreated</a></li><li><a href="Core.Tools.ComboBoxFormFieldCreateTool.html#event:annotationAdded">Core.Tools.ComboBoxFormFieldCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.ComboBoxFormFieldCreateTool.html#event:annotationCreated">Core.Tools.ComboBoxFormFieldCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.CountMeasurementCreateTool.html#event:annotationAdded">Core.Tools.CountMeasurementCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.CountMeasurementCreateTool.html#event:annotationCreated">Core.Tools.CountMeasurementCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.CropCreateTool.html#event:cropApplied">Core.Tools.CropCreateTool#event:cropApplied</a></li><li><a href="Core.Tools.DateFreeTextCreateTool.html#event:annotationAdded">Core.Tools.DateFreeTextCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.DateFreeTextCreateTool.html#event:annotationCreated">Core.Tools.DateFreeTextCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.DistanceMeasurementCreateTool.html#event:annotationAdded">Core.Tools.DistanceMeasurementCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.DistanceMeasurementCreateTool.html#event:annotationCreated">Core.Tools.DistanceMeasurementCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.EllipseCreateTool.html#event:annotationAdded">Core.Tools.EllipseCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.EllipseCreateTool.html#event:annotationCreated">Core.Tools.EllipseCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.EllipseMeasurementCreateTool.html#event:annotationAdded">Core.Tools.EllipseMeasurementCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.EllipseMeasurementCreateTool.html#event:annotationCreated">Core.Tools.EllipseMeasurementCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.EraserTool.html#event:annotationAdded">Core.Tools.EraserTool#event:annotationAdded</a></li><li><a href="Core.Tools.EraserTool.html#event:annotationCreated">Core.Tools.EraserTool#event:annotationCreated</a></li><li><a href="Core.Tools.EraserTool.html#event:erasingAnnotation">Core.Tools.EraserTool#event:erasingAnnotation</a></li><li><a href="Core.Tools.FreeHandCreateTool.html#event:annotationAdded">Core.Tools.FreeHandCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.FreeHandCreateTool.html#event:annotationCreated">Core.Tools.FreeHandCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.FreeHandHighlightCreateTool.html#event:annotationAdded">Core.Tools.FreeHandHighlightCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.FreeHandHighlightCreateTool.html#event:annotationCreated">Core.Tools.FreeHandHighlightCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.FreeTextCreateTool.html#event:annotationAdded">Core.Tools.FreeTextCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.FreeTextCreateTool.html#event:annotationCreated">Core.Tools.FreeTextCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.GenericAnnotationCreateTool.html#event:annotationAdded">Core.Tools.GenericAnnotationCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.GenericAnnotationCreateTool.html#event:annotationCreated">Core.Tools.GenericAnnotationCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.LineCreateTool.html#event:annotationAdded">Core.Tools.LineCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.LineCreateTool.html#event:annotationCreated">Core.Tools.LineCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.ListBoxFormFieldCreateTool.html#event:annotationAdded">Core.Tools.ListBoxFormFieldCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.ListBoxFormFieldCreateTool.html#event:annotationCreated">Core.Tools.ListBoxFormFieldCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.PerimeterMeasurementCreateTool.html#event:annotationAdded">Core.Tools.PerimeterMeasurementCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.PerimeterMeasurementCreateTool.html#event:annotationCreated">Core.Tools.PerimeterMeasurementCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.PolygonCloudCreateTool.html#event:annotationAdded">Core.Tools.PolygonCloudCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.PolygonCloudCreateTool.html#event:annotationCreated">Core.Tools.PolygonCloudCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.PolygonCreateTool.html#event:annotationAdded">Core.Tools.PolygonCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.PolygonCreateTool.html#event:annotationCreated">Core.Tools.PolygonCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.PolylineCreateTool.html#event:annotationAdded">Core.Tools.PolylineCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.PolylineCreateTool.html#event:annotationCreated">Core.Tools.PolylineCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.RadioButtonFormFieldCreateTool.html#event:annotationAdded">Core.Tools.RadioButtonFormFieldCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.RadioButtonFormFieldCreateTool.html#event:annotationCreated">Core.Tools.RadioButtonFormFieldCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.RectangleCreateTool.html#event:annotationAdded">Core.Tools.RectangleCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.RectangleCreateTool.html#event:annotationCreated">Core.Tools.RectangleCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.RectangularAreaMeasurementTool.html#event:annotationAdded">Core.Tools.RectangularAreaMeasurementTool#event:annotationAdded</a></li><li><a href="Core.Tools.RectangularAreaMeasurementTool.html#event:annotationCreated">Core.Tools.RectangularAreaMeasurementTool#event:annotationCreated</a></li><li><a href="Core.Tools.RedactionCreateTool.html#event:annotationAdded">Core.Tools.RedactionCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.RedactionCreateTool.html#event:annotationCreated">Core.Tools.RedactionCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.RubberStampCreateTool.html#event:annotationAdded">Core.Tools.RubberStampCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.SignatureCreateTool.html#event:annotationAdded">Core.Tools.SignatureCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.SignatureCreateTool.html#event:fileRejected">Core.Tools.SignatureCreateTool#event:fileRejected</a></li><li><a href="Core.Tools.SignatureCreateTool.html#event:locationSelected">Core.Tools.SignatureCreateTool#event:locationSelected</a></li><li><a href="Core.Tools.SignatureCreateTool.html#event:signatureDeleted">Core.Tools.SignatureCreateTool#event:signatureDeleted</a></li><li><a href="Core.Tools.SignatureCreateTool.html#event:signatureSaved">Core.Tools.SignatureCreateTool#event:signatureSaved</a></li><li><a href="Core.Tools.StampCreateTool.html#event:annotationAdded">Core.Tools.StampCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.StampCreateTool.html#event:fileRejected">Core.Tools.StampCreateTool#event:fileRejected</a></li><li><a href="Core.Tools.StickyCreateTool.html#event:annotationAdded">Core.Tools.StickyCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.StickyCreateTool.html#event:annotationCreated">Core.Tools.StickyCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.TextAnnotationCreateTool.html#event:annotationAdded">Core.Tools.TextAnnotationCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.TextAnnotationCreateTool.html#event:annotationCreated">Core.Tools.TextAnnotationCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.TextFormFieldCreateTool.html#event:annotationAdded">Core.Tools.TextFormFieldCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.TextFormFieldCreateTool.html#event:annotationCreated">Core.Tools.TextFormFieldCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.TextHighlightCreateTool.html#event:annotationAdded">Core.Tools.TextHighlightCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.TextHighlightCreateTool.html#event:annotationCreated">Core.Tools.TextHighlightCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.TextSelectTool.html#event:selectionComplete">Core.Tools.TextSelectTool#event:selectionComplete</a></li><li><a href="Core.Tools.TextSquigglyCreateTool.html#event:annotationAdded">Core.Tools.TextSquigglyCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.TextSquigglyCreateTool.html#event:annotationCreated">Core.Tools.TextSquigglyCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.TextStrikeoutCreateTool.html#event:annotationAdded">Core.Tools.TextStrikeoutCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.TextStrikeoutCreateTool.html#event:annotationCreated">Core.Tools.TextStrikeoutCreateTool#event:annotationCreated</a></li><li><a href="Core.Tools.TextUnderlineCreateTool.html#event:annotationAdded">Core.Tools.TextUnderlineCreateTool#event:annotationAdded</a></li><li><a href="Core.Tools.TextUnderlineCreateTool.html#event:annotationCreated">Core.Tools.TextUnderlineCreateTool#event:annotationCreated</a></li><li><a href="UI.MentionsManager.html#event:mentionChanged">UI.MentionsManager#event:mentionChanged</a></li><li><a href="UI.html#event:annotationFilterChanged">UI#event:annotationFilterChanged</a></li><li><a href="UI.html#event:beforeTabChanged">UI#event:beforeTabChanged</a></li><li><a href="UI.html#event:documentLoaded">UI#event:documentLoaded</a></li><li><a href="UI.html#event:documentMerged">UI#event:documentMerged</a></li><li><a href="UI.html#event:dragOutline">UI#event:dragOutline</a></li><li><a href="UI.html#event:fileDownloaded">UI#event:fileDownloaded</a></li><li><a href="UI.html#event:finishedSavingPDF">UI#event:finishedSavingPDF</a></li><li><a href="UI.html#event:fullscreenModeToggled">UI#event:fullscreenModeToggled</a></li><li><a href="UI.html#event:loaderror">UI#event:loaderror</a></li><li><a href="UI.html#event:outlineBookmarksChanged">UI#event:outlineBookmarksChanged</a></li><li><a href="UI.html#event:panelResized">UI#event:panelResized</a></li><li><a href="UI.html#event:selectedThumbnailChanged">UI#event:selectedThumbnailChanged</a></li><li><a href="UI.html#event:tabAdded">UI#event:tabAdded</a></li><li><a href="UI.html#event:tabDeleted">UI#event:tabDeleted</a></li><li><a href="UI.html#event:tabMoved">UI#event:tabMoved</a></li><li><a href="UI.html#event:themeChanged">UI#event:themeChanged</a></li><li><a href="UI.html#event:thumbnailDragged">UI#event:thumbnailDragged</a></li><li><a href="UI.html#event:thumbnailDropped">UI#event:thumbnailDropped</a></li><li><a href="UI.html#event:toolbarGroupChanged">UI#event:toolbarGroupChanged</a></li><li><a href="UI.html#event:userBookmarksChanged">UI#event:userBookmarksChanged</a></li><li><a href="UI.html#event:viewerLoaded">UI#event:viewerLoaded</a></li><li><a href="UI.html#event:visibilityChanged">UI#event:visibilityChanged</a></li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="global.html#getInstance">getInstance</a></li><li><a href="global.html#WebViewer">WebViewer</a></li>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-8">
<div id="main">
<h1 class="page-title">Namespace: Core</h1>
<section>
<header>
<h2>
Core
</h2>
</header>
<article>
<div class="container-overview">
<div class="description">WebViewer Instance Core namespace.
The namespace containing WebViewer's core user controls, including DocumentViewer control and the Document class.</div>
<dl class="details">
</dl>
<h3>Example</h3>
<pre class="sunlight-highlight-javascript">webViewerInstance.Core.someProperty
webViewerInstance.Core.someAPI()</pre>
</div>
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="Core.AnnotationHistoryManager.html">AnnotationHistoryManager</a></dt>
<dd></dd>
<dt><a href="Core.AnnotationManager.html">AnnotationManager</a></dt>
<dd></dd>
<dt><a href="Core.Bookmark.html">Bookmark</a></dt>
<dd></dd>
<dt><a href="Core.DisplayMode.html">DisplayMode</a></dt>
<dd></dd>
<dt><a href="Core.DisplayModeManager.html">DisplayModeManager</a></dt>
<dd></dd>
<dt><a href="Core.Document.html">Document</a></dt>
<dd></dd>
<dt><a href="Core.DocumentViewer.html">DocumentViewer</a></dt>
<dd></dd>
<dt><a href="Core.EditBoxManager.html">EditBoxManager</a></dt>
<dd></dd>
<dt><a href="Core.EventHandler.html">EventHandler</a></dt>
<dd></dd>
<dt><a href="Core.MeasurementManager.html">MeasurementManager</a></dt>
<dd></dd>
<dt><a href="Core.Scale.html">Scale</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Namespaces</h3>
<dl>
<dt><a href="namespaces.html#Core.Actions"><a href="Core.Actions.html">Actions</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#Core.Annotations"><a href="Core.Annotations.html">Annotations</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#Core.ContentEdit"><a href="Core.ContentEdit.html">ContentEdit</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#Core.Math"><a href="Core.Math.html">Math</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#Core.PartRetrievers"><a href="Core.PartRetrievers.html">PartRetrievers</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#Core.Search"><a href="Core.Search.html">Search</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#Core.Tools"><a href="Core.Tools.html">Tools</a></a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Members</h3>
<dl>
<hr>
<dt class="name" id=".annotationManager">
<h4 id=".annotationManager"><span class="type-signature"><static> </span>annotationManager</h4>
</dt>
<dd>
<div class="description">
AnnotationManager instance
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Core.AnnotationManager.html">Core.AnnotationManager</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="Core.AnnotationManager.html">Core.AnnotationManager</a></li>
</ul>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">WebViewer(...)
.then(function(instance) {
const annotationManager = instance.Core.annotationManager;
});</pre>
</dd>
<hr>
<dt class="name" id=".BackendTypes">
<h4 id=".BackendTypes"><span class="type-signature"><static> </span>BackendTypes</h4>
</dt>
<dd>
<div class="description">
The types of backend workers.
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ASM</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">'asm' Use of ASM.js worker.</td>
</tr>
<tr>
<td class="name"><code>WASM</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">'ems' Use of the WebAssembly worker (or ASM.js on non-wasm browsers).</td>
</tr>
<tr>
<td class="name"><code>THREADED_WASM</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">'wasm-threads' Use of threaded WebAssembly worker.</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".ColorPostProcessMode">
<h4 id=".ColorPostProcessMode"><span class="type-signature"><static> </span>ColorPostProcessMode</h4>
</dt>
<dd>
<div class="description">
Represents the different color post processing options that can used in the <a href="Core.Document.html#updateRasterizerOptions">updateRasterizerOptions</a> function.
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>NONE</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">No post processing. This is the default setting</td>
</tr>
<tr>
<td class="name"><code>INVERT</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Inverted color mode</td>
</tr>
<tr>
<td class="name"><code>GRADIENT_MAP</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Gradient color mode</td>
</tr>
<tr>
<td class="name"><code>NIGHT_MODE</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Night mode</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".DisplayModes">
<h4 id=".DisplayModes"><span class="type-signature"><static> </span>DisplayModes</h4>
</dt>
<dd>
<div class="description">
Display modes that control how the document's page are displayed
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Single</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Displays one page at a time.</td>
</tr>
<tr>
<td class="name"><code>Continuous</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Displays all the pages in a scrolling view in one column.</td>
</tr>
<tr>
<td class="name"><code>Facing</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Displays up to two pages at a time, side by side.</td>
</tr>
<tr>
<td class="name"><code>FacingContinuous</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Displays all pages in a scrolling view in two columns.</td>
</tr>
<tr>
<td class="name"><code>Cover</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Displays all pages in a scrolling view in two columns. The first row has a single page in the second column.</td>
</tr>
<tr>
<td class="name"><code>CoverFacing</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Same as the Cover display mode except that it is not a scrolling view.</td>
</tr>
<tr>
<td class="name"><code>Custom</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Any custom display mode.</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".documentViewer">
<h4 id=".documentViewer"><span class="type-signature"><static> </span>documentViewer</h4>
</dt>
<dd>
<div class="description">
DocumentViewer instance
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Core.DocumentViewer.html">Core.DocumentViewer</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="Core.DocumentViewer.html">Core.DocumentViewer</a></li>
</ul>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">WebViewer(...)
.then(function(instance) {
const documentViewer = instance.Core.documentViewer;
});</pre>
</dd>
<hr>
<dt class="name" id=".FONT_STYLES">
<h4 id=".FONT_STYLES"><span class="type-signature"><static> </span>FONT_STYLES</h4>
</dt>
<dd>
<div class="description">
Represents the font style for the watermark text
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>BOLD</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">specifies that the text should be bolded</td>
</tr>
<tr>
<td class="name"><code>ITALIC</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">specifies that the text should be italicized</td>
</tr>
<tr>
<td class="name"><code>UNDERLINE</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">specifies that the text should be underlined</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".MarkedStates">
<h4 id=".MarkedStates"><span class="type-signature"><static> </span>MarkedStates</h4>
</dt>
<dd>
<div class="description">
Represents the different Marked state values that you can apply to annotation status.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Marked</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Marked State</td>
</tr>
<tr>
<td class="name"><code>Unmarked</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Unmarked State</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".PageRotation">
<h4 id=".PageRotation"><span class="type-signature"><static> </span>PageRotation</h4>
</dt>
<dd>
<div class="description">
Represents the different page rotation values that you can apply to pages.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>E_0</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">0 degree rotation</td>
</tr>
<tr>
<td class="name"><code>E_90</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">90 degree rotation</td>
</tr>
<tr>
<td class="name"><code>E_180</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">180 degree rotation</td>
</tr>
<tr>
<td class="name"><code>E_270</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">270 degree rotation</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".ReviewStates">
<h4 id=".ReviewStates"><span class="type-signature"><static> </span>ReviewStates</h4>
</dt>
<dd>
<div class="description">
Represents the different review state values that you can apply to annotation status.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Accepted</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Accepted State</td>
</tr>
<tr>
<td class="name"><code>Rejected</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Rejected State</td>
</tr>
<tr>
<td class="name"><code>Cancelled</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Cancelled State</td>
</tr>
<tr>
<td class="name"><code>Completed</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Completed State</td>
</tr>
<tr>
<td class="name"><code>None</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">None State</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".SaveOptions">
<h4 id=".SaveOptions"><span class="type-signature"><static> </span>SaveOptions</h4>
</dt>
<dd>
<div class="description">
Represents the different save option values that you can use in the getFileData function.
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>INCREMENTAL</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Saves new data to the end of the file</td>
</tr>
<tr>
<td class="name"><code>REMOVE_UNUSED</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Removes unused data when saving</td>
</tr>
<tr>
<td class="name"><code>HEX_STRINGS</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Save strings in hexadecimal format</td>
</tr>
<tr>
<td class="name"><code>OMIT_XREF</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Do not save cross reference table</td>
</tr>
<tr>
<td class="name"><code>LINEARIZED</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Optimize data for speed and remove unused data</td>
</tr>
<tr>
<td class="name"><code>COMPATIBILITY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Maximize compatibility with older PDF consumers (e.g. the file will not use object and compressed XREF streams)</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".setBasePath">
<h4 id=".setBasePath"><span class="type-signature"><static> </span>setBasePath</h4>
</dt>
<dd>
<div class="description">
Setting the base path that relatively loading documents will be relative to.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt class="name" id=".StateModel">
<h4 id=".StateModel"><span class="type-signature"><static> </span>StateModel</h4>
</dt>
<dd>
<div class="description">
Represents the different state models that you can apply to annotation.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Marked</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Marked State</td>
</tr>
<tr>
<td class="name"><code>Review</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Review State</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".SupportedFileFormats">
<h4 id=".SupportedFileFormats"><span class="type-signature"><static> </span>SupportedFileFormats</h4>
</dt>
<dd>
<div class="description">
Represents all the supported file formats in WebViewer
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>CLIENT</code></td>
<td class="type">
<span class="param-type">Array.<string></span>
</td>
<td class="description last">Supported file formats when using WebViewer client side rendering</td>
</tr>
<tr>
<td class="name"><code>SERVER</code></td>
<td class="type">
<span class="param-type">Array.<string></span>
</td>
<td class="description last">Supported file formats when using WebViewer with WebViewer Server</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".TextExtractorProcessingFlags">
<h4 id=".TextExtractorProcessingFlags"><span class="type-signature"><static> </span>TextExtractorProcessingFlags</h4>
</dt>
<dd>
<div class="description">
Represents the different processing option values to direct the flow of content recognition algorithms that you can use in the setTextExtractorProcessingFlags function.
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>NO_LIGATURE_EXP</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">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</td>
</tr>
<tr>
<td class="name"><code>NO_DUP_REMOVE</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Disables removing duplicated text that is frequently used to achieve visual effects of drop shadow and fake bold</td>
</tr>
<tr>
<td class="name"><code>PUNCT_BREAK</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Treat punctuation (e.g. full stop, comma, semicolon, etc.) as word break characters</td>
</tr>
<tr>
<td class="name"><code>REMOVE_HIDDEN_TEXT</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Enables removal of text that is obscured by images or rectangles</td>
</tr>
<tr>
<td class="name"><code>NO_INVISIBLE_TEXT</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">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)</td>
</tr>
<tr>
<td class="name"><code>NO_WATERMARKS</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Enables removal of text that is marked as part of a Watermark layer</td>
</tr>
<tr>
<td class="name"><code>EXTRACT_USING_ZORDER</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Use Z-order as reading order for text</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<hr>
<dt>
<h4 class="name" id=".BaseDocument"><span class="type-signature"><static> </span>BaseDocument()</h4>
</dt>
<dd>
<div class="description">
BaseDocument is used to alert if a Document implementation is not following the Document interface.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".createDatePicker"><span class="type-signature"><static> </span>createDatePicker(options)</h4>
</dt>
<dd>
<div class="description">
Create DatePicker UI
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">An object to set the configuration of the date picker
<h6 class="method-params-label method-subparams-label">Properties</h6>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">HTMLElement</span>
</td>
<td class="description last">The HTML form field the date picker should be bound to</td>
</tr>
<tr>
<td class="name"><code>container</code></td>
<td class="type">
<span class="param-type">HTMLElement</span>
</td>
<td class="description last">DOM node to render calendar into</td>
</tr>
<tr>
<td class="name"><code>onDateSelected</code></td>
<td class="type">
<span class="param-type"><a href="Core.html#.onDateSelected">Core.onDateSelected</a></span>
</td>
<td class="description last">Function that is called when the date is selected from the date picker UI</td>
</tr>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the date format showed after select date</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".createDocument"><span class="type-signature"><static> </span>createDocument(src [, options])</h4>
</dt>
<dd>
<div class="description">
Creates an initialized Core.Document instance.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>src</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">File</span>
|
<span class="param-type">ArrayBuffer</span>
|
<span class="param-type">Blob</span>
|
<span class="param-type">Core.PDFNet.PDFDoc</span>
</td>
<td class="attributes">
</td>
<td class="description last">Source parameter, path/url to document or File.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type"><a href="Core.html#.CreateDocumentOptions">Core.CreateDocumentOptions</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Create document options.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Promise that resolves when doc.loadAsync has been successfully called and returns Core.Document instance.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="Core.Document.html">Core.Document</a>></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".disableEmbeddedJavaScript"><span class="type-signature"><static> </span>disableEmbeddedJavaScript()</h4>
</dt>
<dd>
<div class="description">
Disables the execution of embedded JavaScript
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".disableFullPDF"><span class="type-signature"><static> </span>disableFullPDF()</h4>
</dt>
<dd>
<div class="description">
Disable the use of the full version of the PDFNetJS if it had been previously enabled.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".disableLogs"><span class="type-signature"><static> </span>disableLogs(disabled)</h4>
</dt>
<dd>
<div class="description">
Enables or disables all logs coming from WebViewer.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>disabled</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether or not to disable all WebViewer logs. Defaults to true</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".disableOptimizedWorkers"><span class="type-signature"><static> </span>disableOptimizedWorkers()</h4>
</dt>
<dd>
<div class="description">
Set flag to indicate that the optimized workers can not be used.
</div>
<dl class="details">
<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="Core.html#.enableOptimizedWorkers">Core.enableOptimizedWorkers</a> for more details.</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".enableFullPDF"><span class="type-signature"><static> </span>enableFullPDF()</h4>
</dt>
<dd>
<div class="description">
Enable or disable use of the full version of PDFNetJS.
the parameter is deprecated since version 8.0
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".enableOptimizedWorkers"><span class="type-signature"><static> </span>enableOptimizedWorkers()</h4>
</dt>
<dd>
<div class="description">
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.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".enableWorkerLogs"><span class="type-signature"><static> </span>enableWorkerLogs(enabled)</h4>
</dt>
<dd>
<div class="description">
Enables or disables logs from the PDF worker.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>enabled</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether or not to enable PDF worker logs. Defaults to false.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".forceBackendType"><span class="type-signature"><static> </span>forceBackendType(backendType)</h4>
</dt>
<dd>
<div class="description">
Set default backend type. This method can be used for forced backend type for
specific workers, for example, "ems" for Emscripten worker type
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>backendType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Value for default backend type, e.g. asm, ems, wasm-threads, jsworker.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getAllowedFileExtensions"><span class="type-signature"><static> </span>getAllowedFileExtensions()</h4>
</dt>
<dd>
<div class="description">
Get the array of allowed file extensions. An empty array indicates all supported file extensions are allowed.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getBuild"><span class="type-signature"><static> </span>getBuild()</h4>
</dt>
<dd>
<div class="description">
Returns the specific hashed commit id that is used to build the current WebViewer version.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A hashed commit id
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getCanvasMultiplier"><span class="type-signature"><static> </span>getCanvasMultiplier()</h4>
</dt>
<dd>
<div class="description">
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 <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio">devicePixelRatio</a>
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The current value of the canvas multiplier
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getCurrentPDFBackendType"><span class="type-signature"><static> </span>getCurrentPDFBackendType()</h4>
</dt>
<dd>
<div class="description">
Gets the current backend type being used.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
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
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getCurrentPDFBackendType"><span class="type-signature"><static> </span>getCurrentPDFBackendType()</h4>
</dt>
<dd>
<div class="description">
Gets the current backend type loaded or being loaded
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns "asm" if ASM.js is being forced, "ems" if Emscripten is being used or "wasm-threads" if threaded Wasm is being used
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<string></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getDefaultBackendType"><span class="type-signature"><static> </span>getDefaultBackendType()</h4>
</dt>
<dd>
<div class="description">
Gets the default pdf backend type that should be used for this browser.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Returns a promise that resolve to a string. "ems" if Emscripten should be used, and "wasm-threads" if threaded Wasm should be used
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<string></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getExternalPath"><span class="type-signature"><static> </span>getExternalPath()</h4>
</dt>
<dd>
<div class="description">
Get the location of external scripts.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the prefix url external scripts.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getHashParam"><span class="type-signature"><static> </span>getHashParam(property, defaultValue)</h4>
</dt>
<dd>
<div class="description">
Gets the value of the specified hash parameter from the window URL
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>property</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The property key from hash parameter</td>
</tr>
<tr>
<td class="name"><code>defaultValue</code></td>
<td class="type">
<span class="param-type">T</span>
</td>
<td class="description last">Default return value</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>Since version 8.3.
Please use <a href="Core.html#.getHashParameter">getHashParameter</a> instead</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A value of the hash parameter
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">T</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getHashParameter"><span class="type-signature"><static> </span>getHashParameter(property, defaultValue)</h4>
</dt>
<dd>
<div class="description">
Gets the value of the specified hash parameter from the window URL
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>property</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The property key from hash parameter</td>
</tr>
<tr>
<td class="name"><code>defaultValue</code></td>
<td class="type">
<span class="param-type">T</span>
</td>
<td class="description last">Default return value</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A value of the hash parameter
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">T</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getLocalWorkerPath"><span class="type-signature"><static> </span>getLocalWorkerPath()</h4>
</dt>
<dd>
<div class="description">
Get the location of the local worker files.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the path to CORSWorker.js/CoreWorker.js
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getPDFAsmPath"><span class="type-signature"><static> </span>getPDFAsmPath()</h4>
</dt>
<dd>
<div class="description">
Get the location of the PDF asm.js file PDFNetC.gz.js.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the prefix url for PDFNetC.gz.js.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getPDFResourcePath"><span class="type-signature"><static> </span>getPDFResourcePath()</h4>
</dt>
<dd>
<div class="description">
Get the location of PDF resources.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the prefix url for PDFNetC.js.mem and PDFNet.res.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getPDFWorkerPath"><span class="type-signature"><static> </span>getPDFWorkerPath()</h4>
</dt>
<dd>
<div class="description">
Get the location of the PDF worker.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
the prefix url for PDFworker.js
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getResourcesPath"><span class="type-signature"><static> </span>getResourcesPath()</h4>
</dt>
<dd>
<div class="description">
Gets the path to the resources folder
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The path to the resources folder
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getScrollLeft"><span class="type-signature"><static> </span>getScrollLeft(ele)</h4>
</dt>
<dd>
<div class="description">
Gets the scrollLeft value for the element. Takes into account right to left scrolling direction if applicable.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ele</code></td>
<td class="type">
<span class="param-type">Element</span>
</td>
<td class="description last">An HTML element to retrieve the scrollLeft value from</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The scrollLeft value of the element
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getVersion"><span class="type-signature"><static> </span>getVersion()</h4>
</dt>
<dd>
<div class="description">
Returns the WebViewer version.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
WebViewer version
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".getWorkerPath"><span class="type-signature"><static> </span>getWorkerPath()</h4>
</dt>
<dd>
<div class="description">
Gets the path to the Web Worker JavaScript file
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The path to the worker
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".hexStringToNumberArray"><span class="type-signature"><static> </span>hexStringToNumberArray(hexString)</h4>
</dt>
<dd>
<div class="description">
Converts hexadecimal string to a number array.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hexString</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">String of hexadecimal characters</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".initPDFWorkerTransports"><span class="type-signature"><static> </span>initPDFWorkerTransports(pdfBackendType, workerHandlers, l)</h4>
</dt>
<dd>
<div class="description">
Begins setup of PDF Worker Object.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pdfBackendType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">object representing an PDF backend type ("asm", "ems" or "wasm-threads")</td>
</tr>
<tr>
<td class="name"><code>workerHandlers</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">object holding event and error handlers for the worker (workerLoadingProgress, emsWorkerError).</td>
</tr>
<tr>
<td class="name"><code>l</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The license key to use for this worker. If undefined PDFNet will be initialized in demo mode.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
a promise that will be resolved when worker transport initialization is complete.
</div>
</dd>
<hr>
<dt>
<h4 class="name" id=".isBlendModeSupported"><span class="type-signature"><static> </span>isBlendModeSupported(type)</h4>
</dt>
<dd>
<div class="description">
Check if a composite operation is supported
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Composite operation to check</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if if the input composite operation is supported, false otherwise
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".isDemoMode"><span class="type-signature"><static> </span>isDemoMode()</h4>
</dt>
<dd>
<div class="description">
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.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true or false depending on whether the viewer is in demo mode or not
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".isFullPDFEnabled"><span class="type-signature"><static> </span>isFullPDFEnabled()</h4>
</dt>
<dd>
<div class="description">
Returns whether the full version of PDFNetJS is enabled or not.
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
returns true if the full version is enabled and false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".preloadPDFWorker"><span class="type-signature"><static> </span>preloadPDFWorker(pdfBackendType, workerHandlers)</h4>
</dt>
<dd>
<div class="description">
Begins setup of PDF Worker Object. This can be used to load the workers before a license key has been loaded.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pdfBackendType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">object representing a PDF backend type ("asm", "ems" or "wasm-threads")</td>
</tr>
<tr>
<td class="name"><code>workerHandlers</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">object holding event and error handlers for the worker (workerLoadingProgress).</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The worker object
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".resetWorker"><span class="type-signature"><static> </span>resetWorker()</h4>
</dt>
<dd>
<div class="description">
Resets the worker so that the next time initPDFWorkerTransports is called it will set up the worker transports.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setAdvancedImageScaling"><span class="type-signature"><static> </span>setAdvancedImageScaling(advanced)</h4>
</dt>
<dd>
<div class="description">
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.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>advanced</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">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.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setAllowedFileExtensions"><span class="type-signature"><static> </span>setAllowedFileExtensions(fileExtensionArray)</h4>
</dt>
<dd>
<div class="description">
Set the allowed file extensions.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fileExtensionArray</code></td>
<td class="type">
<span class="param-type">Array.<string></span>
</td>
<td class="description last">An array of file extensions, not case sensitive. An empty array will allow any supported file extension to be loaded.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setAsWindowsApp"><span class="type-signature"><static> </span>setAsWindowsApp()</h4>
</dt>
<dd>
<div class="description">
Flag WebViewer as running inside a Windows App so that it automatically uses the WinRTPartRetriever for loading local XOD files
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".SetCachingLevel"><span class="type-signature"><static> </span>SetCachingLevel(level)</h4>
</dt>
<dd>
<div class="description">
Set the caching level between 0 and 10, where 0 is no caching and 10 uses a very large cache. The default is 6.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>level</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The level to set</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setCanvasMultiplier"><span class="type-signature"><static> </span>setCanvasMultiplier(value)</h4>
</dt>
<dd>
<div class="description">
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 <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio">devicePixelRatio</a>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The value of multiplier to be set</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setColorManagement"><span class="type-signature"><static> </span>setColorManagement( [boolean])</h4>
</dt>
<dd>
<div class="description">
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.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>boolean</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">value if true enable color management. Otherwise disable it.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setCustomFontURL"><span class="type-signature"><static> </span>setCustomFontURL(url)</h4>
</dt>
<dd>
<div class="description">
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.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The url at which font resources should be requested.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setEmscriptenHeapSize"><span class="type-signature"><static> </span>setEmscriptenHeapSize(The)</h4>
</dt>
<dd>
<div class="description">
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.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>The</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">number of bytes to allocate for the Emscripten heap.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setExternalPath"><span class="type-signature"><static> </span>setExternalPath()</h4>
</dt>
<dd>
<div class="description">
Set the location of external scripts.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setIsWindowsApp"><span class="type-signature"><static> </span>setIsWindowsApp(isWindowsApp)</h4>
</dt>
<dd>
<div class="description">
Sets whether WebViewer is running inside a Windows App and should automatically use the WinRTPartRetriever for loading local XOD files
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>isWindowsApp</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether WebViewer is running inside a Windows app or not</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
<dd>
<ul class="dummy">
<li>since version 8.0
Please use setAsWindowsApp or unsetAsWindowsApp instead</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setLocalWorkerPath"><span class="type-signature"><static> </span>setLocalWorkerPath(workerPath, isExact)</h4>
</dt>
<dd>
<div class="description">
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.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>workerPath</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The path to the local worker files</td>
</tr>
<tr>
<td class="name"><code>isExact</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">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</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setPDFAsmPath"><span class="type-signature"><static> </span>setPDFAsmPath(workerPath)</h4>
</dt>
<dd>
<div class="description">
Set the location of the PDF worker. This will override the location specified by Core.setWorkerPath for PDF worker files.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>workerPath</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the prefix url for PDFNetC.gz.js.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setPDFResourcePath"><span class="type-signature"><static> </span>setPDFResourcePath(resourcePath)</h4>
</dt>
<dd>
<div class="description">
Set the location of PDF resources. This will override the location specified by Core.setWorkerPath for PDF resource files.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>resourcePath</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the prefix url for PDFNetC.js.mem and PDFNet.res.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setPDFWorkerPath"><span class="type-signature"><static> </span>setPDFWorkerPath(workerPath)</h4>
</dt>
<dd>
<div class="description">
Set the location of the PDF worker. This will override the location specified by Core.setWorkerPath for PDF worker files.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>workerPath</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the prefix url for PDFworker.js</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".SetPreRenderLevel"><span class="type-signature"><static> </span>SetPreRenderLevel(level)</h4>
</dt>
<dd>
<div class="description">
Set the pre-render level between 0 and 10, where 0 has pre-rendering and 10 has a lot of pre-rendering.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>level</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The level to set</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setProgressiveTime"><span class="type-signature"><static> </span>setProgressiveTime(milliseconds)</h4>
</dt>
<dd>
<div class="description">
Control the time between progressive events when rendering a more complex page.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>milliseconds</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">the number of milliseconds between progressive events. By default this is disabled for XOD and 3 seconds (3000) otherwise.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setResourcesPath"><span class="type-signature"><static> </span>setResourcesPath(path)</h4>
</dt>
<dd>
<div class="description">
Sets the path to the resources folder.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Path to the resources folder relative to the HTML file</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".setWorkerPath"><span class="type-signature"><static> </span>setWorkerPath(path)</h4>
</dt>
<dd>
<div class="description">
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
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Path to the Web Worker JS file relative to the html file of the viewer</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".syncNamespaces"><span class="type-signature"><static> </span>syncNamespaces(namespaces)</h4>
</dt>
<dd>
<div class="description">
Syncs the namespaces under the Core namespace attached to the <b>window only</b>.
<br/><br/>
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.
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>namespaces</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">The object containing the namespaces that will be used.
<h6 class="method-params-label method-subparams-label">Properties</h6>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>PDFNet</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The PDFNet namespace. This is probably the most common that needs to be synced.</td>
</tr>
<tr>
<td class="name"><code>Actions</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The Actions namespace.</td>
</tr>
<tr>
<td class="name"><code>Annotations</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The Annotations namespace.</td>
</tr>
<tr>
<td class="name"><code>Math</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The Math namespace.</td>
</tr>
<tr>
<td class="name"><code>Tools</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The Tools namespace.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".unsetAsWindowsApp"><span class="type-signature"><static> </span>unsetAsWindowsApp()</h4>
</dt>
<dd>
<div class="description">
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.
</div>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".unsetCanvasMultiplier"><span class="type-signature"><static> </span>unsetCanvasMultiplier()</h4>
</dt>
<dd>
<div class="description">
Unsets the multiplier that was set using the setCanvasMultiplier function.
The multiplier will default back to the browser's <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio">devicePixelRatio</a>
</div>
<dl class="details">
</dl>
</dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<dl>
<hr>
<dt class="name" id=".CreateDocumentOptions">
<h4 id=".CreateDocumentOptions">CreateDocumentOptions</h4>
</dt>
<dd>
<div class="description">
Create document options.
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>l</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Same as licenseKey.</td>
</tr>
<tr>
<td class="name"><code>licenseKey</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The license key for viewing PDF or Office files (PDF/Office only). You only need to use one of 'l' or 'licenseKey'.</td>
</tr>
<tr>
<td class="name"><code>docId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An unique identifier for the document, used for offline mode.</td>
</tr>
<tr>
<td class="name"><code>onLoadingProgress</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A callback function for loading progress, function signature function(percent) {}.</td>
</tr>
<tr>
<td class="name"><code>onError</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A callback function that will be called when error occurs in the process of creating a document. function signature function(e) {}</td>
</tr>
<tr>
<td class="name"><code>workerTransportPromise</code></td>
<td class="type">
<span class="param-type">Promise.<any></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The workerTransportPromise that should be used to load the document.</td>
</tr>
<tr>
<td class="name"><code>password</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>filename</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A filename that is used for the downloaded file, and for determining the extension when options.extension isn't used.</td>
</tr>
<tr>
<td class="name"><code>extension</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>customHeaders</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An object containing custom HTTP headers to use when retrieving the document from the specified url. For example: {'Authorization' : 'Basic dXNlcm5hbWU6cGFzc3dvcmQ='}.</td>
</tr>
<tr>
<td class="name"><code>useDownloader</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A boolean indicating whether Downloader should be used on urls (PDF only). https://www.pdftron.com/documentation/web/guides/usedownloader-option/.</td>
</tr>
<tr>
<td class="name"><code>withCredentials</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Whether to set the withCredentials property on the XMLHttpRequest.</td>
</tr>
<tr>
<td class="name"><code>pageSizes</code></td>
<td class="type">
<span class="param-type">Array.<object></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An array of objects in the shape of { width: number, height: number }. Used to determine the page sizes when loading an image file.</td>
</tr>
<tr>
<td class="name"><code>backendType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>xodOptions</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An object that contains the options for a XOD document.
<h6>Properties</h6>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>decrypt</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Function to be called to decrypt a part of the XOD file. For default XOD AES encryption pass Core.Encryption.decrypt.</td>
</tr>
<tr>
<td class="name"><code>decryptOptions</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An object with options for the decryption e.g. {p: "pass", type: "aes"} where is p is the password.</td>
</tr>
<tr>
<td class="name"><code>streaming</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>azureWorkaround</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>startOffline</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">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.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>webviewerServerURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A URL to the WebViewer server drop-in backend https://www.pdftron.com/documentation/web/guides/wv-server-deployment.</td>
</tr>
<tr>
<td class="name"><code>fallbackToClientSide</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A boolean indicating whether to fall back to client side rendering when WebViewer server fails</td>
</tr>
<tr>
<td class="name"><code>cacheKey</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A key that will be used for caching the document on WebViewer Server.</td>
</tr>
<tr>
<td class="name"><code>forceClientSideInit</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>loadAsPDF</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If set to true then this will convert any office file passed in into a PDF document</td>
</tr>
<tr>
<td class="name"><code>customHandlerId</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A field used to specify PDFTron custom security handler. Its value needs to be an integer in [0, 0xFFFFFFFF].</td>
</tr>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">A custom document type. If set then the document type is not determined from the file extension.</td>
</tr>
<tr>
<td class="name"><code>customDocParams</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An object used to pass properties down to a custom document type.</td>
</tr>
<tr>
<td class="name"><code>isRelativePath</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If true, source will be considered as relative path/url.</td>
</tr>
<tr>
<td class="name"><code>officeOptions</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An object that contains the options for an Office document.
<h6>Properties</h6>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>templateValues</code></td>
<td class="type">
<span class="param-type"><a href="Core.html#.TemplateData">Core.TemplateData</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If set, will perform template replacement with the data specified by this parameter</td>
</tr>
<tr>
<td class="name"><code>doTemplatePrep</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If set, it will interpret the office document as a template document and compile all of the template tags in the document</td>
</tr>
<tr>
<td class="name"><code>disableBrowserFontSubstitution</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>formatOptions</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">An object that contains formatting options for an Office document. Same options as allowed here Core.PDFNet.Convert.OfficeToPDFOptions.
<h6>Properties</h6>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>applyPageBreaksToSheet</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If true will split Excel worksheets into pages so that the output resembles print output.</td>
</tr>
<tr>
<td class="name"><code>displayChangeTracking</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>excelDefaultCellBorderWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>excelMaxAllowedCellCount</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>locale</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">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.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".onDateSelected"><span class="type-signature"></span>onDateSelected(date)</h4>
</dt>
<dd>
<div class="description">
Callback function for when a date is selected
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>date</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">selected Date</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateBoundingBox">
<h4 id=".TemplateBoundingBox">TemplateBoundingBox</h4>
</dt>
<dd>
<div class="description">
A bounding box of template tag text or template inserted content.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pageNum</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The page index (1-based indexing) this bounding box appears on.</td>
</tr>
<tr>
<td class="name"><code>box</code></td>
<td class="type">
<span class="param-type"><a href="Core.Math.Rect.html">Core.Math.Rect</a></span>
</td>
<td class="description last">The bounding box, units are points.</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateBoundingBoxes">
<h4 id=".TemplateBoundingBoxes">TemplateBoundingBoxes</h4>
</dt>
<dd>
<div class="description">
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:
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object.<string, Array.<<a href="Core.html#.TemplateBoundingBox">Core.TemplateBoundingBox</a>>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://www.pdftron.com/documentation/windows/guides/generate-via-template/advanced/#explicit-loop-scope">https://www.pdftron.com/documentation/windows/guides/generate-via-template/advanced/#explicit-loop-scope</a> for more information on loop scoping.</li>
</ul>
</dd>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">'loop_var_1::loop_var_2 ... ::item_var'</pre>
</dd>
<hr>
<dt class="name" id=".TemplateData">
<h4 id=".TemplateData">TemplateData</h4>
</dt>
<dd>
<div class="description">
Office template data (input supplied to applyTemplateValues).
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Core.html#.TemplateDataKeyValues">Core.TemplateDataKeyValues</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://www.pdftron.com/documentation/core/guides/generate-via-template/data-model/">https://www.pdftron.com/documentation/core/guides/generate-via-template/data-model/</a> for a detailed specification of the template format and supported features.</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateDataContent">
<h4 id=".TemplateDataContent">TemplateDataContent</h4>
</dt>
<dd>
<div class="description">
A replacement value for a simple data tag, @example '{{tag}}'
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Core.html#.TemplateDataText">Core.TemplateDataText</a></span>
|
<span class="param-type"><a href="Core.html#.TemplateDataImage">Core.TemplateDataImage</a></span>
</li>
</ul>
<dl class="details">
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateDataImage">
<h4 id=".TemplateDataImage">TemplateDataImage</h4>
</dt>
<dd>
<div class="description">
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.
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>image_url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">URL to download image from.</td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The image width, measure in points.</td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The image height, measured in points.</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateDataKeyValues">
<h4 id=".TemplateDataKeyValues">TemplateDataKeyValues</h4>
</dt>
<dd>
<div class="description">
A dictionary of template keys and their replacement values.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object.<string, <a href="Core.html#.TemplateDataValue">Core.TemplateDataValue</a>></span>
</li>
</ul>
<dl class="details">
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateDataLoop">
<h4 id=".TemplateDataLoop">TemplateDataLoop</h4>
</dt>
<dd>
<div class="description">
The argument to a template loop: an array which will be looped over.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="Core.html#.TemplateDataKeyValues">Core.TemplateDataKeyValues</a>></span>
</li>
</ul>
<dl class="details">
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateDataText">
<h4 id=".TemplateDataText">TemplateDataText</h4>
</dt>
<dd>
<div class="description">
A text replacement value.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
|
<span class="param-type"><a href="Core.html#.TemplateDataTextExplicit">Core.TemplateDataTextExplicit</a></span>
|
<span class="param-type"><a href="Core.html#.TemplateDataTextLines">Core.TemplateDataTextLines</a></span>
</li>
</ul>
<dl class="details">
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateDataTextExplicit">
<h4 id=".TemplateDataTextExplicit">TemplateDataTextExplicit</h4>
</dt>
<dd>
<div class="description">
Simple text, equivalent to just passing a string.
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateDataTextLines">
<h4 id=".TemplateDataTextLines">TemplateDataTextLines</h4>
</dt>
<dd>
<div class="description">
An array of text which will separated by line breaks.
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>text_lines</code></td>
<td class="type">
<span class="param-type">Array.<string></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateDataValue">
<h4 id=".TemplateDataValue">TemplateDataValue</h4>
</dt>
<dd>
<div class="description">
A replacement value for a tag.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Core.html#.TemplateDataContent">Core.TemplateDataContent</a></span>
|
<span class="param-type"><a href="Core.html#.TemplateDataLoop">Core.TemplateDataLoop</a></span>
|
<span class="param-type"><a href="Core.html#.TemplateDataKeyValues">Core.TemplateDataKeyValues</a></span>
|
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateSchema">
<h4 id=".TemplateSchema">TemplateSchema</h4>
</dt>
<dd>
<div class="description">
Office template schema (output returned from getTemplateKeys with format: schema).
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>keys</code></td>
<td class="type">
<span class="param-type"><a href="Core.html#.TemplateSchemaKeyValues">Core.TemplateSchemaKeyValues</a></span>
</td>
<td class="description last">The top-level template keys in the document.</td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://www.pdftron.com/documentation/core/guides/generate-via-template/data-model/">https://www.pdftron.com/documentation/core/guides/generate-via-template/data-model/</a> for a detailed specification of the template format and supported features.</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateSchemaBool">
<h4 id=".TemplateSchemaBool">TemplateSchemaBool</h4>
</dt>
<dd>
<div class="description">
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.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>typeId</code></td>
<td class="type">
<span class="param-type">'TemplateSchemaBool'</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>docOrder</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">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).</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateSchemaContent">
<h4 id=".TemplateSchemaContent">TemplateSchemaContent</h4>
</dt>
<dd>
<div class="description">
This indicates there is a template tag for this key that will be replaced with content, such as text or an image.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>typeId</code></td>
<td class="type">
<span class="param-type">'TemplateSchemaContent'</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>docOrder</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">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).</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateSchemaKeyValues">
<h4 id=".TemplateSchemaKeyValues">TemplateSchemaKeyValues</h4>
</dt>
<dd>
<div class="description">
A dictionary of template keys and their expected data types.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object.<string, <a href="Core.html#.TemplateSchemaValue">Core.TemplateSchemaValue</a>></span>
</li>
</ul>
<dl class="details">
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateSchemaLoop">
<h4 id=".TemplateSchemaLoop">TemplateSchemaLoop</h4>
</dt>
<dd>
<div class="description">
This indicates the key is a loop. Since a key may be reused in multiple loops, the loopType property is an array.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>typeId</code></td>
<td class="type">
<span class="param-type">'TemplateSchemaLoop'</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>docOrder</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">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).</td>
</tr>
<tr>
<td class="name"><code>itemSchema</code></td>
<td class="type">
<span class="param-type"><a href="Core.html#.TemplateSchemaKeyValues">Core.TemplateSchemaKeyValues</a></span>
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>loopType</code></td>
<td class="type">
<span class="param-type">Array.<('tableRow'|'orderedList'|'unorderedList'|'other')></span>
</td>
<td class="description last">Array of the loop types, ordered by their document ordering.</td>
</tr>
</tbody>
</table>
</dl>
</dl>
</dd>
<hr>
<dt class="name" id=".TemplateSchemaObject">
<h4 id=".TemplateSchemaObject">TemplateSchemaObject</h4>
</dt>
<dd>
<div class="description">
This indicates the key is used as an object in a tag dot expression.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>typeId</code></td>
<td class="type">
<span class="param-type">'TemplateSchemaObject'</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>docOrder</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">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).</td>
</tr>
<tr>
<td class="name"><code>properties</code></td>
<td class="type">
<span class="param-type"><a href="Core.html#.TemplateSchemaKeyValues">Core.TemplateSchemaKeyValues</a></span>
</td>
<td class="description last">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.</td>
</tr>
</tbody>
</table>
</dl>
</dl>
<h5>Example</h5>
<pre class="sunlight-highlight-javascript">'obj' in the tag '{{obj.prop}}'</pre>
</dd>
<hr>
<dt class="name" id=".TemplateSchemaValue">
<h4 id=".TemplateSchemaValue">TemplateSchemaValue</h4>
</dt>
<dd>
<div class="description">
The expected type of input data for a template tag.
The type can be read from the typeId property.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Core.html#.TemplateSchemaContent">Core.TemplateSchemaContent</a></span>
|
<span class="param-type"><a href="Core.html#.TemplateSchemaBool">Core.TemplateSchemaBool</a></span>
|
<span class="param-type"><a href="Core.html#.TemplateSchemaLoop">Core.TemplateSchemaLoop</a></span>
|
<span class="param-type"><a href="Core.html#.TemplateSchemaObject">Core.TemplateSchemaObject</a></span>
</li>
</ul>
<dl class="details">
</dl>
</dd>
</dl>
</article>
</section>
</div>
</div>
<div class="clearfix"></div>
<div class="col-md-3">
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
</div>
</div>
</div>
<div class="modal fade" id="searchResults">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body"></div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>
<footer>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
on 2023-06-16T14:56:40-07:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : false,
showMenu : true,
enableDoclinks : true
} );
$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
<script type="text/javascript">
$(document).ready(function() {
SearcherDisplay.init();
});
</script>
</body>
</html>